@aws-sdk/client-sfn 3.296.0 → 3.298.0

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartExecutionInput, StartExecutionOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
 /**
+ * @public
+ *
  * The input for {@link StartExecutionCommand}.
  */
 export interface StartExecutionCommandInput extends StartExecutionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StartExecutionCommand}.
  */
 export interface StartExecutionCommandOutput extends StartExecutionOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts a state machine execution. If the given state machine Amazon Resource Name (ARN) is a qualified state machine ARN, it will fail with ValidationException.</p>
  *
  *          <p>A qualified state machine ARN refers to a <i>Distributed Map state</i> defined within a state machine. For example, the qualified state machine ARN <code>arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel</code> refers to a <i>Distributed Map state</i> with a label <code>mapStateLabel</code> in the state machine named <code>stateMachineName</code>.</p>
@@ -38,6 +43,8 @@ export interface StartExecutionCommandOutput extends StartExecutionOutput, __Met
  * const response = await client.send(command);
  * ```
  *
+ * @param StartExecutionCommandInput - {@link StartExecutionCommandInput}
+ * @returns {@link StartExecutionCommandOutput}
  * @see {@link StartExecutionCommandInput} for command's `input` shape.
  * @see {@link StartExecutionCommandOutput} for command's `response` shape.
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -77,11 +84,20 @@ export interface StartExecutionCommandOutput extends StartExecutionOutput, __Met
 export declare class StartExecutionCommand extends $Command<StartExecutionCommandInput, StartExecutionCommandOutput, SFNClientResolvedConfig> {
     readonly input: StartExecutionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartExecutionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartExecutionCommandInput, StartExecutionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StartSyncExecutionInput, StartSyncExecutionOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
 /**
+ * @public
+ *
  * The input for {@link StartSyncExecutionCommand}.
  */
 export interface StartSyncExecutionCommandInput extends StartSyncExecutionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StartSyncExecutionCommand}.
  */
 export interface StartSyncExecutionCommandOutput extends StartSyncExecutionOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Starts a Synchronous Express state machine execution. <code>StartSyncExecution</code>
  * 			  is not available for <code>STANDARD</code> workflows.</p>
  *          <note>
@@ -37,6 +42,8 @@ export interface StartSyncExecutionCommandOutput extends StartSyncExecutionOutpu
  * const response = await client.send(command);
  * ```
  *
+ * @param StartSyncExecutionCommandInput - {@link StartSyncExecutionCommandInput}
+ * @returns {@link StartSyncExecutionCommandOutput}
  * @see {@link StartSyncExecutionCommandInput} for command's `input` shape.
  * @see {@link StartSyncExecutionCommandOutput} for command's `response` shape.
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -64,11 +71,20 @@ export interface StartSyncExecutionCommandOutput extends StartSyncExecutionOutpu
 export declare class StartSyncExecutionCommand extends $Command<StartSyncExecutionCommandInput, StartSyncExecutionCommandOutput, SFNClientResolvedConfig> {
     readonly input: StartSyncExecutionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StartSyncExecutionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StartSyncExecutionCommandInput, StartSyncExecutionCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { StopExecutionInput, StopExecutionOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
 /**
+ * @public
+ *
  * The input for {@link StopExecutionCommand}.
  */
 export interface StopExecutionCommandInput extends StopExecutionInput {
 }
 /**
+ * @public
+ *
  * The output of {@link StopExecutionCommand}.
  */
 export interface StopExecutionCommandOutput extends StopExecutionOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Stops an execution.</p>
  *          <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
  * @example
@@ -26,6 +31,8 @@ export interface StopExecutionCommandOutput extends StopExecutionOutput, __Metad
  * const response = await client.send(command);
  * ```
  *
+ * @param StopExecutionCommandInput - {@link StopExecutionCommandInput}
+ * @returns {@link StopExecutionCommandOutput}
  * @see {@link StopExecutionCommandInput} for command's `input` shape.
  * @see {@link StopExecutionCommandOutput} for command's `response` shape.
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -44,11 +51,20 @@ export interface StopExecutionCommandOutput extends StopExecutionOutput, __Metad
 export declare class StopExecutionCommand extends $Command<StopExecutionCommandInput, StopExecutionCommandOutput, SFNClientResolvedConfig> {
     readonly input: StopExecutionCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: StopExecutionCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<StopExecutionCommandInput, StopExecutionCommandOutput>;
+    /**
+     * @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, TagResourceOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
 /**
+ * @public
+ *
  * The input for {@link TagResourceCommand}.
  */
 export interface TagResourceCommandInput extends TagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link TagResourceCommand}.
  */
 export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Add a tag to a Step Functions resource.</p>
  *          <p>An array of key-value pairs. For more information, see <a href="https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html">Using
  *       Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
@@ -30,6 +35,8 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
  * 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 SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -50,11 +57,20 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
 export declare class TagResourceCommand extends $Command<TagResourceCommandInput, TagResourceCommandOutput, SFNClientResolvedConfig> {
     readonly input: TagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: TagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<TagResourceCommandInput, TagResourceCommandOutput>;
+    /**
+     * @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, UntagResourceOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
 /**
+ * @public
+ *
  * The input for {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandInput extends UntagResourceInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UntagResourceCommand}.
  */
 export interface UntagResourceCommandOutput extends UntagResourceOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Remove a tag from a Step Functions resource</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 UntagResourceOutput, __Metad
  * 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 SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -41,11 +48,20 @@ export interface UntagResourceCommandOutput extends UntagResourceOutput, __Metad
 export declare class UntagResourceCommand extends $Command<UntagResourceCommandInput, UntagResourceCommandOutput, SFNClientResolvedConfig> {
     readonly input: UntagResourceCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UntagResourceCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UntagResourceCommandInput, UntagResourceCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateMapRunInput, UpdateMapRunOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateMapRunCommand}.
  */
 export interface UpdateMapRunCommandInput extends UpdateMapRunInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateMapRunCommand}.
  */
 export interface UpdateMapRunCommandOutput extends UpdateMapRunOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
@@ -25,6 +30,8 @@ export interface UpdateMapRunCommandOutput extends UpdateMapRunOutput, __Metadat
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateMapRunCommandInput - {@link UpdateMapRunCommandInput}
+ * @returns {@link UpdateMapRunCommandOutput}
  * @see {@link UpdateMapRunCommandInput} for command's `input` shape.
  * @see {@link UpdateMapRunCommandOutput} for command's `response` shape.
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -44,11 +51,20 @@ export interface UpdateMapRunCommandOutput extends UpdateMapRunOutput, __Metadat
 export declare class UpdateMapRunCommand extends $Command<UpdateMapRunCommandInput, UpdateMapRunCommandOutput, SFNClientResolvedConfig> {
     readonly input: UpdateMapRunCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateMapRunCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateMapRunCommandInput, UpdateMapRunCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

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

@@ -4,16 +4,21 @@ import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as
 import { UpdateStateMachineInput, UpdateStateMachineOutput } from "../models/models_0";
 import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
 /**
+ * @public
+ *
  * The input for {@link UpdateStateMachineCommand}.
  */
 export interface UpdateStateMachineCommandInput extends UpdateStateMachineInput {
 }
 /**
+ * @public
+ *
  * The output of {@link UpdateStateMachineCommand}.
  */
 export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutput, __MetadataBearer {
 }
 /**
+ * @public
  * <p>Updates an existing state machine by modifying its <code>definition</code>,
  *         <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue
  *       to use the previous <code>definition</code> and <code>roleArn</code>. You must include at
@@ -40,6 +45,8 @@ export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutpu
  * const response = await client.send(command);
  * ```
  *
+ * @param UpdateStateMachineCommandInput - {@link UpdateStateMachineCommandInput}
+ * @returns {@link UpdateStateMachineCommandOutput}
  * @see {@link UpdateStateMachineCommandInput} for command's `input` shape.
  * @see {@link UpdateStateMachineCommandOutput} for command's `response` shape.
  * @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
@@ -75,11 +82,20 @@ export interface UpdateStateMachineCommandOutput extends UpdateStateMachineOutpu
 export declare class UpdateStateMachineCommand extends $Command<UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput, SFNClientResolvedConfig> {
     readonly input: UpdateStateMachineCommandInput;
     static getEndpointParameterInstructions(): EndpointParameterInstructions;
+    /**
+     * @public
+     */
     constructor(input: UpdateStateMachineCommandInput);
     /**
      * @internal
      */
     resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateStateMachineCommandInput, UpdateStateMachineCommandOutput>;
+    /**
+     * @internal
+     */
     private serialize;
+    /**
+     * @internal
+     */
     private deserialize;
 }

package/dist-types/models/SFNServiceException.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 SFN service.
  */
 export declare class SFNServiceException extends __ServiceException {