@aws-sdk/client-swf 3.296.0 → 3.297.0

package/dist-types/commands/StartWorkflowExecutionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { Run, StartWorkflowExecutionInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
 /**
+ * @public
+ *
  * The input for {@link StartWorkflowExecutionCommand}.
  */
 export interface StartWorkflowExecutionCommandInput extends StartWorkflowExecutionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StartWorkflowExecutionCommand}.
  */
 export interface StartWorkflowExecutionCommandOutput extends Run, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts an execution of the workflow type in the specified domain using the provided
  *         <code>workflowId</code> and input data.</p>
  *
@@ -90,6 +95,8 @@ export interface StartWorkflowExecutionCommandOutput extends Run, __MetadataBear
  * const response = await client.send(command);
  * ```
  *
+ * @param StartWorkflowExecutionCommandInput - {@link StartWorkflowExecutionCommandInput}
+ * @returns {@link StartWorkflowExecutionCommandOutput}
  * @see {@link StartWorkflowExecutionCommandInput} for command's `input` shape.
  * @see {@link StartWorkflowExecutionCommandOutput} for command's `response` shape.
  * @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
@@ -128,11 +135,20 @@ export interface StartWorkflowExecutionCommandOutput extends Run, __MetadataBear
 export declare class StartWorkflowExecutionCommand extends $Command<StartWorkflowExecutionCommandInput, StartWorkflowExecutionCommandOutput, SWFClientResolvedConfig> {
     readonly input: StartWorkflowExecutionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartWorkflowExecutionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartWorkflowExecutionCommandInput, StartWorkflowExecutionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TagResourceInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Add a tag to a Amazon SWF domain.</p>
  *          <note>
  *             <p>Amazon SWF supports a maximum of 50 tags per resource.</p>
@@ -28,6 +33,8 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param TagResourceCommandInput - {@link TagResourceCommandInput}
+ * @returns {@link TagResourceCommandOutput}
  * @see {@link TagResourceCommandInput} for command's `input` shape.
  * @see {@link TagResourceCommandOutput} for command's `response` shape.
  * @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
@@ -49,11 +56,20 @@ export interface TagResourceCommandOutput extends __MetadataBearer {
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SWFClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/TerminateWorkflowExecutionCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { TerminateWorkflowExecutionInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
 /**
+ * @public
+ *
  * The input for {@link TerminateWorkflowExecutionCommand}.
  */
 export interface TerminateWorkflowExecutionCommandInput extends TerminateWorkflowExecutionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link TerminateWorkflowExecutionCommand}.
  */
 export interface TerminateWorkflowExecutionCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Records a <code>WorkflowExecutionTerminated</code> event and forces closure of the
  *       workflow execution identified by the given domain, runId, and workflowId. The child policy,
  *       registered with the workflow type or specified when starting this execution, is applied to any
@@ -68,6 +73,8 @@ export interface TerminateWorkflowExecutionCommandOutput extends __MetadataBeare
  * const response = await client.send(command);
  * ```
  *
+ * @param TerminateWorkflowExecutionCommandInput - {@link TerminateWorkflowExecutionCommandInput}
+ * @returns {@link TerminateWorkflowExecutionCommandOutput}
  * @see {@link TerminateWorkflowExecutionCommandInput} for command's `input` shape.
  * @see {@link TerminateWorkflowExecutionCommandOutput} for command's `response` shape.
  * @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
@@ -83,11 +90,20 @@ export interface TerminateWorkflowExecutionCommandOutput extends __MetadataBeare
 export declare class TerminateWorkflowExecutionCommand extends $Command<TerminateWorkflowExecutionCommandInput, TerminateWorkflowExecutionCommandOutput, SWFClientResolvedConfig> {
     readonly input: TerminateWorkflowExecutionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TerminateWorkflowExecutionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TerminateWorkflowExecutionCommandInput, TerminateWorkflowExecutionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UndeprecateActivityTypeCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UndeprecateActivityTypeInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
 /**
+ * @public
+ *
  * The input for {@link UndeprecateActivityTypeCommand}.
  */
 export interface UndeprecateActivityTypeCommandInput extends UndeprecateActivityTypeInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UndeprecateActivityTypeCommand}.
  */
 export interface UndeprecateActivityTypeCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Undeprecates a previously deprecated <i>activity type</i>. After an activity type has
  *       been undeprecated, you can create new tasks of that activity type.</p>
  *          <note>
@@ -66,6 +71,8 @@ export interface UndeprecateActivityTypeCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UndeprecateActivityTypeCommandInput - {@link UndeprecateActivityTypeCommandInput}
+ * @returns {@link UndeprecateActivityTypeCommandOutput}
  * @see {@link UndeprecateActivityTypeCommandInput} for command's `input` shape.
  * @see {@link UndeprecateActivityTypeCommandOutput} for command's `response` shape.
  * @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
@@ -84,11 +91,20 @@ export interface UndeprecateActivityTypeCommandOutput extends __MetadataBearer {
 export declare class UndeprecateActivityTypeCommand extends $Command<UndeprecateActivityTypeCommandInput, UndeprecateActivityTypeCommandOutput, SWFClientResolvedConfig> {
     readonly input: UndeprecateActivityTypeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UndeprecateActivityTypeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UndeprecateActivityTypeCommandInput, UndeprecateActivityTypeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UndeprecateDomainCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UndeprecateDomainInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
 /**
+ * @public
+ *
  * The input for {@link UndeprecateDomainCommand}.
  */
 export interface UndeprecateDomainCommandInput extends UndeprecateDomainInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UndeprecateDomainCommand}.
  */
 export interface UndeprecateDomainCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Undeprecates a previously deprecated domain. After a domain has been undeprecated it can be used
  *       to create new workflow executions or register new types.</p>
  *          <note>
@@ -53,6 +58,8 @@ export interface UndeprecateDomainCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UndeprecateDomainCommandInput - {@link UndeprecateDomainCommandInput}
+ * @returns {@link UndeprecateDomainCommandOutput}
  * @see {@link UndeprecateDomainCommandInput} for command's `input` shape.
  * @see {@link UndeprecateDomainCommandOutput} for command's `response` shape.
  * @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
@@ -71,11 +78,20 @@ export interface UndeprecateDomainCommandOutput extends __MetadataBearer {
 export declare class UndeprecateDomainCommand extends $Command<UndeprecateDomainCommandInput, UndeprecateDomainCommandOutput, SWFClientResolvedConfig> {
     readonly input: UndeprecateDomainCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UndeprecateDomainCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UndeprecateDomainCommandInput, UndeprecateDomainCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UndeprecateWorkflowTypeCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UndeprecateWorkflowTypeInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
 /**
+ * @public
+ *
  * The input for {@link UndeprecateWorkflowTypeCommand}.
  */
 export interface UndeprecateWorkflowTypeCommandInput extends UndeprecateWorkflowTypeInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UndeprecateWorkflowTypeCommand}.
  */
 export interface UndeprecateWorkflowTypeCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Undeprecates a previously deprecated <i>workflow type</i>. After a workflow type has
  *       been undeprecated, you can create new executions of that type. </p>
  *          <note>
@@ -66,6 +71,8 @@ export interface UndeprecateWorkflowTypeCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UndeprecateWorkflowTypeCommandInput - {@link UndeprecateWorkflowTypeCommandInput}
+ * @returns {@link UndeprecateWorkflowTypeCommandOutput}
  * @see {@link UndeprecateWorkflowTypeCommandInput} for command's `input` shape.
  * @see {@link UndeprecateWorkflowTypeCommandOutput} for command's `response` shape.
  * @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
@@ -84,11 +91,20 @@ export interface UndeprecateWorkflowTypeCommandOutput extends __MetadataBearer {
 export declare class UndeprecateWorkflowTypeCommand extends $Command<UndeprecateWorkflowTypeCommandInput, UndeprecateWorkflowTypeCommandOutput, SWFClientResolvedConfig> {
     readonly input: UndeprecateWorkflowTypeCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UndeprecateWorkflowTypeCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UndeprecateWorkflowTypeCommandInput, UndeprecateWorkflowTypeCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/commands/UntagResourceCommand.d.ts

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UntagResourceInput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SWFClientResolvedConfig } from "../SWFClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends __MetadataBearer {
 }
 /**
+ * @public
  * <p>Remove a tag from a Amazon SWF domain.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
  * const response = await client.send(command);
  * ```
  *
+ * @param UntagResourceCommandInput - {@link UntagResourceCommandInput}
+ * @returns {@link UntagResourceCommandOutput}
  * @see {@link UntagResourceCommandInput} for command's `input` shape.
  * @see {@link UntagResourceCommandOutput} for command's `response` shape.
  * @see {@link SWFClientResolvedConfig | config} for SWFClient's `config` shape.
@@ -43,11 +50,20 @@ export interface UntagResourceCommandOutput extends __MetadataBearer {
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SWFClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SWFServiceException.d.ts

@@ -1,5 +1,7 @@
 import { ServiceException as __ServiceException, ServiceExceptionOptions as __ServiceExceptionOptions } from "@aws-sdk/smithy-client";
 /**
+ * @public
+ *
  * Base exception class for all service exceptions from SWF service.
  */
 export declare class SWFServiceException extends __ServiceException {