@aws-sdk/client-swf 3.35.0 → 3.38.0

package/dist-types/ts3.4/commands/ListWorkflowTypesCommand.d.ts

@@ -6,53 +6,11 @@ export interface ListWorkflowTypesCommandInput extends ListWorkflowTypesInput {
 }
 export interface ListWorkflowTypesCommandOutput extends WorkflowTypeInfos, __MetadataBearer {
 }
-/**
- * <p>Returns information about workflow types in the specified domain. The results may be
- *       split into multiple pages that can be retrieved by making the call repeatedly.</p>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>You cannot use an IAM policy to constrain this action's parameters.</p>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class ListWorkflowTypesCommand extends $Command<ListWorkflowTypesCommandInput, ListWorkflowTypesCommandOutput, SWFClientResolvedConfig> {
     readonly input: ListWorkflowTypesCommandInput;
     constructor(input: ListWorkflowTypesCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<ListWorkflowTypesCommandInput, ListWorkflowTypesCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/PollForActivityTaskCommand.d.ts

@@ -6,64 +6,11 @@ export interface PollForActivityTaskCommandInput extends PollForActivityTaskInpu
 }
 export interface PollForActivityTaskCommandOutput extends ActivityTask, __MetadataBearer {
 }
-/**
- * <p>Used by workers to get an <a>ActivityTask</a> from the specified activity
- *         <code>taskList</code>. This initiates a long poll, where the service holds the HTTP
- *       connection open and responds as soon as a task becomes available. The maximum time the service
- *       holds on to the request before responding is 60 seconds. If no task is available within 60
- *       seconds, the poll returns an empty result. An empty result, in this context, means that an
- *       ActivityTask is returned, but that the value of taskToken is an empty string. If a task is
- *       returned, the worker should use its type to identify and process it correctly.</p>
- *          <important>
- *             <p>Workers should set their client side socket timeout to at least 70 seconds (10
- *         seconds higher than the maximum time service may hold the poll request).</p>
- *          </important>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>Constrain the <code>taskList.name</code> parameter by using a
- *             <code>Condition</code> element with the <code>swf:taskList.name</code> key to allow the
- *           action to access only certain task lists.</p>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class PollForActivityTaskCommand extends $Command<PollForActivityTaskCommandInput, PollForActivityTaskCommandOutput, SWFClientResolvedConfig> {
     readonly input: PollForActivityTaskCommandInput;
     constructor(input: PollForActivityTaskCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PollForActivityTaskCommandInput, PollForActivityTaskCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/PollForDecisionTaskCommand.d.ts

@@ -6,76 +6,11 @@ export interface PollForDecisionTaskCommandInput extends PollForDecisionTaskInpu
 }
 export interface PollForDecisionTaskCommandOutput extends DecisionTask, __MetadataBearer {
 }
-/**
- * <p>Used by deciders to get a <a>DecisionTask</a> from the specified decision
- *         <code>taskList</code>. A decision task may be returned for any open workflow execution that
- *       is using the specified task list. The task includes a paginated view of the history of the
- *       workflow execution. The decider should use the workflow type and the history to determine how
- *       to properly handle the task.</p>
- *          <p>This action initiates a long poll, where the service holds the HTTP connection open and
- *       responds as soon a task becomes available. If no decision task is available in the specified
- *       task list before the timeout of 60 seconds expires, an empty result is returned. An empty
- *       result, in this context, means that a DecisionTask is returned, but that the value of
- *       taskToken is an empty string.</p>
- *          <important>
- *             <p>Deciders should set their client side socket timeout to at least 70 seconds (10
- *         seconds higher than the timeout).</p>
- *          </important>
- *          <important>
- *             <p>Because the number of workflow history events for a single workflow execution might
- *         be very large, the result returned might be split up across a number of pages. To retrieve
- *         subsequent pages, make additional calls to <code>PollForDecisionTask</code> using the
- *           <code>nextPageToken</code> returned by the initial call. Note that you do
- *           <i>not</i> call <code>GetWorkflowExecutionHistory</code> with this
- *           <code>nextPageToken</code>. Instead, call <code>PollForDecisionTask</code>
- *         again.</p>
- *          </important>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>Constrain the <code>taskList.name</code> parameter by using a
- *             <code>Condition</code> element with the <code>swf:taskList.name</code> key to allow the
- *           action to access only certain task lists.</p>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class PollForDecisionTaskCommand extends $Command<PollForDecisionTaskCommandInput, PollForDecisionTaskCommandOutput, SWFClientResolvedConfig> {
     readonly input: PollForDecisionTaskCommandInput;
     constructor(input: PollForDecisionTaskCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<PollForDecisionTaskCommandInput, PollForDecisionTaskCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/RecordActivityTaskHeartbeatCommand.d.ts

@@ -6,76 +6,11 @@ export interface RecordActivityTaskHeartbeatCommandInput extends RecordActivityT
 }
 export interface RecordActivityTaskHeartbeatCommandOutput extends ActivityTaskStatus, __MetadataBearer {
 }
-/**
- * <p>Used by activity workers to report to the service that the <a>ActivityTask</a> represented by the specified <code>taskToken</code> is still making progress. The worker
- *       can also specify details of the progress, for example percent complete, using the
- *         <code>details</code> parameter. This action can also be used by the worker as a mechanism to
- *       check if cancellation is being requested for the activity task. If a cancellation is being
- *       attempted for the specified task, then the boolean <code>cancelRequested</code> flag returned
- *       by the service is set to <code>true</code>.</p>
- *          <p>This action resets the <code>taskHeartbeatTimeout</code> clock. The
- *         <code>taskHeartbeatTimeout</code> is specified in <a>RegisterActivityType</a>.</p>
- *          <p>This action doesn't in itself create an event in the workflow execution history.
- *       However, if the task times out, the workflow execution history contains a
- *         <code>ActivityTaskTimedOut</code> event that contains the information from the last
- *       heartbeat generated by the activity worker.</p>
- *          <note>
- *             <p>The <code>taskStartToCloseTimeout</code> of an activity type is the maximum duration
- *         of an activity task, regardless of the number of <a>RecordActivityTaskHeartbeat</a> requests received. The <code>taskStartToCloseTimeout</code> is also specified in <a>RegisterActivityType</a>.</p>
- *          </note>
- *          <note>
- *             <p>This operation is only useful for long-lived activities to report liveliness of the
- *         task and to determine if a cancellation is being attempted.</p>
- *          </note>
- *          <important>
- *             <p>If the <code>cancelRequested</code> flag returns <code>true</code>, a cancellation is
- *         being attempted. If the worker can cancel the activity, it should respond with <a>RespondActivityTaskCanceled</a>. Otherwise, it should ignore the cancellation
- *         request.</p>
- *          </important>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>You cannot use an IAM policy to constrain this action's parameters.</p>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class RecordActivityTaskHeartbeatCommand extends $Command<RecordActivityTaskHeartbeatCommandInput, RecordActivityTaskHeartbeatCommandOutput, SWFClientResolvedConfig> {
     readonly input: RecordActivityTaskHeartbeatCommandInput;
     constructor(input: RecordActivityTaskHeartbeatCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RecordActivityTaskHeartbeatCommandInput, RecordActivityTaskHeartbeatCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/RegisterActivityTypeCommand.d.ts

@@ -6,75 +6,11 @@ export interface RegisterActivityTypeCommandInput extends RegisterActivityTypeIn
 }
 export interface RegisterActivityTypeCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Registers a new <i>activity type</i> along with its configuration
- *       settings in the specified domain.</p>
- *          <important>
- *             <p>A <code>TypeAlreadyExists</code> fault is returned if the type already exists in the
- *         domain. You cannot change any configuration settings of the type after its registration, and
- *         it must be registered as a new version.</p>
- *          </important>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>Constrain the following parameters by using a <code>Condition</code> element with
- *           the appropriate keys.</p>
- *                <ul>
- *                   <li>
- *                      <p>
- *                         <code>defaultTaskList.name</code>: String constraint. The key is
- *                 <code>swf:defaultTaskList.name</code>.</p>
- *                   </li>
- *                   <li>
- *                      <p>
- *                         <code>name</code>: String constraint. The key is <code>swf:name</code>.</p>
- *                   </li>
- *                   <li>
- *                      <p>
- *                         <code>version</code>: String constraint. The key is
- *               <code>swf:version</code>.</p>
- *                   </li>
- *                </ul>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class RegisterActivityTypeCommand extends $Command<RegisterActivityTypeCommandInput, RegisterActivityTypeCommandOutput, SWFClientResolvedConfig> {
     readonly input: RegisterActivityTypeCommandInput;
     constructor(input: RegisterActivityTypeCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterActivityTypeCommandInput, RegisterActivityTypeCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/RegisterDomainCommand.d.ts

@@ -6,52 +6,11 @@ export interface RegisterDomainCommandInput extends RegisterDomainInput {
 }
 export interface RegisterDomainCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Registers a new domain.</p>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>You cannot use an IAM policy to control domain access for this action. The name of
- *           the domain being registered is available as the resource of this action.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>You cannot use an IAM policy to constrain this action's parameters.</p>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class RegisterDomainCommand extends $Command<RegisterDomainCommandInput, RegisterDomainCommandOutput, SWFClientResolvedConfig> {
     readonly input: RegisterDomainCommandInput;
     constructor(input: RegisterDomainCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterDomainCommandInput, RegisterDomainCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/RegisterWorkflowTypeCommand.d.ts

@@ -6,76 +6,11 @@ export interface RegisterWorkflowTypeCommandInput extends RegisterWorkflowTypeIn
 }
 export interface RegisterWorkflowTypeCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Registers a new <i>workflow type</i> and its configuration settings in
- *       the specified domain.</p>
- *          <p>The retention period for the workflow history is set by the <a>RegisterDomain</a> action.</p>
- *          <important>
- *             <p>If the type already exists, then a <code>TypeAlreadyExists</code> fault is returned.
- *         You cannot change the configuration settings of a workflow type once it is registered and it
- *         must be registered as a new version.</p>
- *          </important>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>Constrain the following parameters by using a <code>Condition</code> element with
- *           the appropriate keys.</p>
- *                <ul>
- *                   <li>
- *                      <p>
- *                         <code>defaultTaskList.name</code>: String constraint. The key is
- *                 <code>swf:defaultTaskList.name</code>.</p>
- *                   </li>
- *                   <li>
- *                      <p>
- *                         <code>name</code>: String constraint. The key is <code>swf:name</code>.</p>
- *                   </li>
- *                   <li>
- *                      <p>
- *                         <code>version</code>: String constraint. The key is
- *               <code>swf:version</code>.</p>
- *                   </li>
- *                </ul>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class RegisterWorkflowTypeCommand extends $Command<RegisterWorkflowTypeCommandInput, RegisterWorkflowTypeCommandOutput, SWFClientResolvedConfig> {
     readonly input: RegisterWorkflowTypeCommandInput;
     constructor(input: RegisterWorkflowTypeCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RegisterWorkflowTypeCommandInput, RegisterWorkflowTypeCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/RequestCancelWorkflowExecutionCommand.d.ts

@@ -6,67 +6,11 @@ export interface RequestCancelWorkflowExecutionCommandInput extends RequestCance
 }
 export interface RequestCancelWorkflowExecutionCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Records a <code>WorkflowExecutionCancelRequested</code> event in the currently running
- *       workflow execution identified by the given domain, workflowId, and runId. This logically
- *       requests the cancellation of the workflow execution as a whole. It is up to the decider to
- *       take appropriate actions when it receives an execution history with this event.</p>
- *
- *          <note>
- *             <p>If the runId isn't specified, the <code>WorkflowExecutionCancelRequested</code> event
- *         is recorded in the history of the current open workflow execution with the specified
- *         workflowId in the domain.</p>
- *          </note>
- *
- *          <note>
- *             <p>Because this action allows the workflow to properly clean up and gracefully close, it
- *         should be used instead of <a>TerminateWorkflowExecution</a> when
- *         possible.</p>
- *          </note>
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>You cannot use an IAM policy to constrain this action's parameters.</p>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class RequestCancelWorkflowExecutionCommand extends $Command<RequestCancelWorkflowExecutionCommandInput, RequestCancelWorkflowExecutionCommandOutput, SWFClientResolvedConfig> {
     readonly input: RequestCancelWorkflowExecutionCommandInput;
     constructor(input: RequestCancelWorkflowExecutionCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RequestCancelWorkflowExecutionCommandInput, RequestCancelWorkflowExecutionCommandOutput>;
     private serialize;
     private deserialize;

package/dist-types/ts3.4/commands/RespondActivityTaskCanceledCommand.d.ts

@@ -6,70 +6,11 @@ export interface RespondActivityTaskCanceledCommandInput extends RespondActivity
 }
 export interface RespondActivityTaskCanceledCommandOutput extends __MetadataBearer {
 }
-/**
- * <p>Used by workers to tell the service that the <a>ActivityTask</a> identified
- *       by the <code>taskToken</code> was successfully canceled. Additional <code>details</code> can
- *       be provided using the <code>details</code> argument.</p>
- *
- *          <p>These <code>details</code> (if provided) appear in the
- *         <code>ActivityTaskCanceled</code> event added to the workflow history.</p>
- *
- *          <important>
- *             <p>Only use this operation if the <code>canceled</code> flag of a <a>RecordActivityTaskHeartbeat</a> request returns <code>true</code> and if the
- *         activity can be safely undone or abandoned.</p>
- *          </important>
- *
- *          <p>A task is considered open from the time that it is scheduled until it is closed.
- *       Therefore a task is reported as open while a worker is processing it. A task is closed after
- *       it has been specified in a call to <a>RespondActivityTaskCompleted</a>,
- *       RespondActivityTaskCanceled, <a>RespondActivityTaskFailed</a>, or the task has
- *         <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dg-basic.html#swf-dev-timeout-types">timed
- *         out</a>.</p>
- *
- *          <p>
- *             <b>Access Control</b>
- *          </p>
- *          <p>You can use IAM policies to control this action's access to Amazon SWF resources as
- *       follows:</p>
- *          <ul>
- *             <li>
- *                <p>Use a <code>Resource</code> element with the domain name to limit the action to
- *           only specified domains.</p>
- *             </li>
- *             <li>
- *                <p>Use an <code>Action</code> element to allow or deny permission to call this
- *           action.</p>
- *             </li>
- *             <li>
- *                <p>You cannot use an IAM policy to constrain this action's parameters.</p>
- *             </li>
- *          </ul>
- *          <p>If the caller doesn't have sufficient permissions to invoke the action, or the
- *       parameter values fall outside the specified constraints, the action fails. The associated
- *       event attribute's <code>cause</code> parameter is set to <code>OPERATION_NOT_PERMITTED</code>.
- *       For details and example IAM policies, see <a href="https://docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html">Using IAM to Manage Access to Amazon SWF
- *         Workflows</a> in the <i>Amazon SWF Developer Guide</i>.</p>
- * @example
- * Use 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 declare class RespondActivityTaskCanceledCommand extends $Command<RespondActivityTaskCanceledCommandInput, RespondActivityTaskCanceledCommandOutput, SWFClientResolvedConfig> {
     readonly input: RespondActivityTaskCanceledCommandInput;
     constructor(input: RespondActivityTaskCanceledCommandInput);
-    /**
-     * @internal
-     */
+    
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SWFClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RespondActivityTaskCanceledCommandInput, RespondActivityTaskCanceledCommandOutput>;
     private serialize;
     private deserialize;