@aws-sdk/client-sfn 3.450.0 → 3.451.0

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

@@ -658,7 +658,7 @@ export interface RoutingConfigurationListItem {
     stateMachineVersionArn: string | undefined;
     /**
      * @public
-     * <p>The percentage of traffic you want to route to the second state machine
+     * <p>The percentage of traffic you want to route to a state machine
      *       version. The sum of the weights in the routing
      *       configuration must be equal to 100.</p>
      */
@@ -864,6 +864,19 @@ export interface CloudWatchEventsExecutionDataDetails {
      */
     included?: boolean;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ExecutionRedriveStatus: {
+    readonly NOT_REDRIVABLE: "NOT_REDRIVABLE";
+    readonly REDRIVABLE: "REDRIVABLE";
+    readonly REDRIVABLE_BY_MAP_RUN: "REDRIVABLE_BY_MAP_RUN";
+};
+/**
+ * @public
+ */
+export type ExecutionRedriveStatus = (typeof ExecutionRedriveStatus)[keyof typeof ExecutionRedriveStatus];
 /**
  * @public
  * @enum
@@ -871,6 +884,7 @@ export interface CloudWatchEventsExecutionDataDetails {
 export declare const ExecutionStatus: {
     readonly ABORTED: "ABORTED";
     readonly FAILED: "FAILED";
+    readonly PENDING_REDRIVE: "PENDING_REDRIVE";
     readonly RUNNING: "RUNNING";
     readonly SUCCEEDED: "SUCCEEDED";
     readonly TIMED_OUT: "TIMED_OUT";
@@ -993,6 +1007,77 @@ export interface DescribeExecutionOutput {
      *       state machine version ARN, this field will be null.</p>
      */
     stateMachineAliasArn?: string;
+    /**
+     * @public
+     * <p>The number of times you've redriven an execution. If you have not yet redriven an execution, the <code>redriveCount</code> is 0. This count is not updated for redrives that failed to start or are pending to be redriven.</p>
+     */
+    redriveCount?: number;
+    /**
+     * @public
+     * <p>The date the execution was last redriven. If you have not yet redriven an execution, the <code>redriveDate</code> is null.</p>
+     *          <p>The <code>redriveDate</code> is unavailable if you redrive a Map Run that starts child workflow executions of type <code>EXPRESS</code>.</p>
+     */
+    redriveDate?: Date;
+    /**
+     * @public
+     * <p>Indicates whether or not an execution can be redriven at a given point in time.</p>
+     *          <ul>
+     *             <li>
+     *                <p>For executions of type <code>STANDARD</code>, <code>redriveStatus</code> is <code>NOT_REDRIVABLE</code> if calling the <a>RedriveExecution</a> API action would return the <code>ExecutionNotRedrivable</code> error.</p>
+     *             </li>
+     *             <li>
+     *                <p>For a Distributed Map that includes child workflows of type <code>STANDARD</code>, <code>redriveStatus</code> indicates whether or not the Map Run can redrive child workflow executions.</p>
+     *             </li>
+     *             <li>
+     *                <p>For a Distributed Map that includes child workflows of type <code>EXPRESS</code>, <code>redriveStatus</code> indicates whether or not the Map Run can redrive child workflow executions.</p>
+     *                <p>You can redrive failed or timed out <code>EXPRESS</code> workflows <i>only if</i> they're a part of a Map Run. When you <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">redrive</a> the Map Run, these workflows are restarted using the <a>StartExecution</a> API action.</p>
+     *             </li>
+     *          </ul>
+     */
+    redriveStatus?: ExecutionRedriveStatus;
+    /**
+     * @public
+     * <p>When <code>redriveStatus</code> is <code>NOT_REDRIVABLE</code>, <code>redriveStatusReason</code> specifies the reason why an execution cannot be redriven.</p>
+     *          <ul>
+     *             <li>
+     *                <p>For executions of type <code>STANDARD</code>, or for a Distributed Map that includes child workflows of type <code>STANDARD</code>, <code>redriveStatusReason</code> can include one of the following reasons:</p>
+     *                <ul>
+     *                   <li>
+     *                      <p>
+     *                         <code>State machine is in DELETING status</code>.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>Execution is RUNNING and cannot be redriven</code>.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>Execution is SUCCEEDED and cannot be redriven</code>.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>Execution was started before the launch of RedriveExecution</code>.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>Execution history event limit exceeded</code>.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>Execution has exceeded the max execution time</code>.</p>
+     *                   </li>
+     *                   <li>
+     *                      <p>
+     *                         <code>Execution redrivable period exceeded</code>.</p>
+     *                   </li>
+     *                </ul>
+     *             </li>
+     *             <li>
+     *                <p>For a Distributed Map that includes child workflows of type <code>EXPRESS</code>, <code>redriveStatusReason</code> is only returned if the child workflows are not redrivable. This happens when the child workflow executions have completed successfully.</p>
+     *             </li>
+     *          </ul>
+     */
+    redriveStatusReason?: string;
 }
 /**
  * @public
@@ -1061,6 +1146,16 @@ export interface MapRunExecutionCounts {
      * <p>Returns the count of child workflow executions whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.</p>
      */
     resultsWritten: number | undefined;
+    /**
+     * @public
+     * <p>The number of <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> child workflow executions that cannot be redriven because their execution status is terminal. For example, if your execution event history contains 25,000 entries, or the <code>toleratedFailureCount</code> or <code>toleratedFailurePercentage</code> for the Distributed Map has exceeded.</p>
+     */
+    failuresNotRedrivable?: number;
+    /**
+     * @public
+     * <p>The number of unsuccessful child workflow executions currently waiting to be redriven. The status of these child workflow executions could be <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> in the original execution attempt or a previous redrive attempt.</p>
+     */
+    pendingRedrive?: number;
 }
 /**
  * @public
@@ -1107,6 +1202,16 @@ export interface MapRunItemCounts {
      * <p>Returns the count of items whose results were written by <code>ResultWriter</code>. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/input-output-resultwriter.html">ResultWriter</a> in the <i>Step Functions Developer Guide</i>.</p>
      */
     resultsWritten: number | undefined;
+    /**
+     * @public
+     * <p>The number of <code>FAILED</code>, <code>ABORTED</code>, or <code>TIMED_OUT</code> items in child workflow executions that cannot be redriven because the execution status of those child workflows is terminal. For example, if your execution event history contains 25,000 entries, or the <code>toleratedFailureCount</code> or <code>toleratedFailurePercentage</code> for the Distributed Map has exceeded.</p>
+     */
+    failuresNotRedrivable?: number;
+    /**
+     * @public
+     * <p>The number of unsuccessful items in child workflow executions currently waiting to be redriven.</p>
+     */
+    pendingRedrive?: number;
 }
 /**
  * @public
@@ -1176,6 +1281,16 @@ export interface DescribeMapRunOutput {
      * <p>A JSON object that contains information about the total number of child workflow executions for the Map Run, and the count of child workflow executions for each status, such as <code>failed</code> and <code>succeeded</code>.</p>
      */
     executionCounts: MapRunExecutionCounts | undefined;
+    /**
+     * @public
+     * <p>The number of times you've redriven a Map Run. If you have not yet redriven a Map Run, the <code>redriveCount</code> is 0. This count is not updated for redrives that failed to start or are pending to be redriven.</p>
+     */
+    redriveCount?: number;
+    /**
+     * @public
+     * <p>The date a Map Run was last redriven. If you have not yet redriven a Map Run, the <code>redriveDate</code> is null.</p>
+     */
+    redriveDate?: Date;
 }
 /**
  * @public
@@ -1522,6 +1637,17 @@ export interface ExecutionFailedEventDetails {
      */
     cause?: string;
 }
+/**
+ * @public
+ * <p>Contains details about a redriven execution.</p>
+ */
+export interface ExecutionRedrivenEventDetails {
+    /**
+     * @public
+     * <p>The number of times you've redriven an execution. If you have not yet redriven an execution, the <code>redriveCount</code> is 0. This count is not updated for redrives that failed to start or are pending to be redriven.</p>
+     */
+    redriveCount?: number;
+}
 /**
  * @public
  * <p>Contains details about the start of the execution.</p>
@@ -1741,6 +1867,22 @@ export interface MapRunFailedEventDetails {
      */
     cause?: string;
 }
+/**
+ * @public
+ * <p>Contains details about a Map Run that was redriven.</p>
+ */
+export interface MapRunRedrivenEventDetails {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of a Map Run that was redriven.</p>
+     */
+    mapRunArn?: string;
+    /**
+     * @public
+     * <p>The number of times the Map Run has been redriven at this point in the execution's history including this event. The redrive count for a redriven Map Run is always greater than 0.</p>
+     */
+    redriveCount?: number;
+}
 /**
  * @public
  * <p>Contains details about a Map Run that was started during a state machine execution.</p>
@@ -2057,6 +2199,7 @@ export declare const HistoryEventType: {
     readonly ChoiceStateExited: "ChoiceStateExited";
     readonly ExecutionAborted: "ExecutionAborted";
     readonly ExecutionFailed: "ExecutionFailed";
+    readonly ExecutionRedriven: "ExecutionRedriven";
     readonly ExecutionStarted: "ExecutionStarted";
     readonly ExecutionSucceeded: "ExecutionSucceeded";
     readonly ExecutionTimedOut: "ExecutionTimedOut";
@@ -2074,6 +2217,7 @@ export declare const HistoryEventType: {
     readonly MapIterationSucceeded: "MapIterationSucceeded";
     readonly MapRunAborted: "MapRunAborted";
     readonly MapRunFailed: "MapRunFailed";
+    readonly MapRunRedriven: "MapRunRedriven";
     readonly MapRunStarted: "MapRunStarted";
     readonly MapRunSucceeded: "MapRunSucceeded";
     readonly MapStateAborted: "MapStateAborted";
@@ -2232,6 +2376,11 @@ export interface HistoryEvent {
      * <p>Contains details about the execution timeout that occurred during the execution.</p>
      */
     executionTimedOutEventDetails?: ExecutionTimedOutEventDetails;
+    /**
+     * @public
+     * <p>Contains details about the redrive attempt of an execution.</p>
+     */
+    executionRedrivenEventDetails?: ExecutionRedrivenEventDetails;
     /**
      * @public
      * <p>Contains details about Map state that was started.</p>
@@ -2309,6 +2458,11 @@ export interface HistoryEvent {
      * <p>Contains error and cause details about a Map Run that failed.</p>
      */
     mapRunFailedEventDetails?: MapRunFailedEventDetails;
+    /**
+     * @public
+     * <p>Contains details about the redrive attempt of a Map Run.</p>
+     */
+    mapRunRedrivenEventDetails?: MapRunRedrivenEventDetails;
 }
 /**
  * @public
@@ -2372,6 +2526,18 @@ export interface ListActivitiesOutput {
      */
     nextToken?: string;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ExecutionRedriveFilter: {
+    readonly NOT_REDRIVEN: "NOT_REDRIVEN";
+    readonly REDRIVEN: "REDRIVEN";
+};
+/**
+ * @public
+ */
+export type ExecutionRedriveFilter = (typeof ExecutionRedriveFilter)[keyof typeof ExecutionRedriveFilter];
 /**
  * @public
  */
@@ -2408,6 +2574,14 @@ export interface ListExecutionsInput {
      *          <p>You can specify either a <code>mapRunArn</code> or a <code>stateMachineArn</code>, but not both.</p>
      */
     mapRunArn?: string;
+    /**
+     * @public
+     * <p>Sets a filter to list executions based on whether or not they have been redriven.</p>
+     *          <p>For a Distributed Map, <code>redriveFilter</code> sets a filter to list child workflow executions based on whether or not they have been redriven.</p>
+     *          <p>If you do not provide a <code>redriveFilter</code>, Step Functions returns a list of both redriven and non-redriven executions.</p>
+     *          <p>If you provide a state machine ARN in <code>redriveFilter</code>, the API returns a validation exception.</p>
+     */
+    redriveFilter?: ExecutionRedriveFilter;
 }
 /**
  * @public
@@ -2489,6 +2663,16 @@ export interface ExecutionListItem {
      *          <p>If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.</p>
      */
     stateMachineAliasArn?: string;
+    /**
+     * @public
+     * <p>The number of times you've redriven an execution. If you have not yet redriven an execution, the <code>redriveCount</code> is 0. This count is not updated for redrives that failed to start or are pending to be redriven.</p>
+     */
+    redriveCount?: number;
+    /**
+     * @public
+     * <p>The date the execution was last redriven.</p>
+     */
+    redriveDate?: Date;
 }
 /**
  * @public
@@ -2829,6 +3013,56 @@ export interface PublishStateMachineVersionOutput {
      */
     stateMachineVersionArn: string | undefined;
 }
+/**
+ * @public
+ * <p>The maximum number of running executions has been reached. Running executions must end or
+ *       be stopped before a new execution can be started.</p>
+ */
+export declare class ExecutionLimitExceeded extends __BaseException {
+    readonly name: "ExecutionLimitExceeded";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ExecutionLimitExceeded, __BaseException>);
+}
+/**
+ * @public
+ * <p>The execution Amazon Resource Name (ARN) that you specified for <code>executionArn</code> cannot be redriven.</p>
+ */
+export declare class ExecutionNotRedrivable extends __BaseException {
+    readonly name: "ExecutionNotRedrivable";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ExecutionNotRedrivable, __BaseException>);
+}
+/**
+ * @public
+ */
+export interface RedriveExecutionInput {
+    /**
+     * @public
+     * <p>The Amazon Resource Name (ARN) of the execution to be redriven.</p>
+     */
+    executionArn: string | undefined;
+    /**
+     * @public
+     * <p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API uses one of the last 10 client tokens provided.</p>
+     */
+    clientToken?: string;
+}
+/**
+ * @public
+ */
+export interface RedriveExecutionOutput {
+    /**
+     * @public
+     * <p>The date the execution was last redriven.</p>
+     */
+    redriveDate: Date | undefined;
+}
 /**
  * @public
  */
@@ -2858,6 +3092,7 @@ export interface SendTaskFailureOutput {
 }
 /**
  * @public
+ * <p>The activity does not exist.</p>
  */
 export declare class TaskDoesNotExist extends __BaseException {
     readonly name: "TaskDoesNotExist";
@@ -2869,6 +3104,7 @@ export declare class TaskDoesNotExist extends __BaseException {
 }
 /**
  * @public
+ * <p>The task token has either expired or the task associated with the token has already been closed.</p>
  */
 export declare class TaskTimedOut extends __BaseException {
     readonly name: "TaskTimedOut";
@@ -2946,19 +3182,6 @@ export declare class ExecutionAlreadyExists extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ExecutionAlreadyExists, __BaseException>);
 }
-/**
- * @public
- * <p>The maximum number of running executions has been reached. Running executions must end or
- *       be stopped before a new execution can be started.</p>
- */
-export declare class ExecutionLimitExceeded extends __BaseException {
-    readonly name: "ExecutionLimitExceeded";
-    readonly $fault: "client";
-    /**
-     * @internal
-     */
-    constructor(opts: __ExceptionOptionType<ExecutionLimitExceeded, __BaseException>);
-}
 /**
  * @public
  * <p>The provided JSON input data is not valid.</p>
@@ -3015,6 +3238,7 @@ export interface StartExecutionInput {
      *       This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,
      *     see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
      *     Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p>
+     *          <p>If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.</p>
      *          <p>A name must <i>not</i> contain:</p>
      *          <ul>
      *             <li>

package/dist-types/protocols/Aws_json1_0.d.ts

@@ -23,6 +23,7 @@ import { ListStateMachinesCommandInput, ListStateMachinesCommandOutput } from ".
 import { ListStateMachineVersionsCommandInput, ListStateMachineVersionsCommandOutput } from "../commands/ListStateMachineVersionsCommand";
 import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "../commands/ListTagsForResourceCommand";
 import { PublishStateMachineVersionCommandInput, PublishStateMachineVersionCommandOutput } from "../commands/PublishStateMachineVersionCommand";
+import { RedriveExecutionCommandInput, RedriveExecutionCommandOutput } from "../commands/RedriveExecutionCommand";
 import { SendTaskFailureCommandInput, SendTaskFailureCommandOutput } from "../commands/SendTaskFailureCommand";
 import { SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput } from "../commands/SendTaskHeartbeatCommand";
 import { SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput } from "../commands/SendTaskSuccessCommand";
@@ -126,6 +127,10 @@ export declare const se_ListTagsForResourceCommand: (input: ListTagsForResourceC
  * serializeAws_json1_0PublishStateMachineVersionCommand
  */
 export declare const se_PublishStateMachineVersionCommand: (input: PublishStateMachineVersionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
+/**
+ * serializeAws_json1_0RedriveExecutionCommand
+ */
+export declare const se_RedriveExecutionCommand: (input: RedriveExecutionCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
 /**
  * serializeAws_json1_0SendTaskFailureCommand
  */
@@ -262,6 +267,10 @@ export declare const de_ListTagsForResourceCommand: (output: __HttpResponse, con
  * deserializeAws_json1_0PublishStateMachineVersionCommand
  */
 export declare const de_PublishStateMachineVersionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<PublishStateMachineVersionCommandOutput>;
+/**
+ * deserializeAws_json1_0RedriveExecutionCommand
+ */
+export declare const de_RedriveExecutionCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RedriveExecutionCommandOutput>;
 /**
  * deserializeAws_json1_0SendTaskFailureCommand
  */

package/dist-types/ts3.4/SFN.d.ts

@@ -91,6 +91,10 @@ import {
   PublishStateMachineVersionCommandInput,
   PublishStateMachineVersionCommandOutput,
 } from "./commands/PublishStateMachineVersionCommand";
+import {
+  RedriveExecutionCommandInput,
+  RedriveExecutionCommandOutput,
+} from "./commands/RedriveExecutionCommand";
 import {
   SendTaskFailureCommandInput,
   SendTaskFailureCommandOutput,
@@ -436,6 +440,19 @@ export interface SFN {
     options: __HttpHandlerOptions,
     cb: (err: any, data?: PublishStateMachineVersionCommandOutput) => void
   ): void;
+  redriveExecution(
+    args: RedriveExecutionCommandInput,
+    options?: __HttpHandlerOptions
+  ): Promise<RedriveExecutionCommandOutput>;
+  redriveExecution(
+    args: RedriveExecutionCommandInput,
+    cb: (err: any, data?: RedriveExecutionCommandOutput) => void
+  ): void;
+  redriveExecution(
+    args: RedriveExecutionCommandInput,
+    options: __HttpHandlerOptions,
+    cb: (err: any, data?: RedriveExecutionCommandOutput) => void
+  ): void;
   sendTaskFailure(
     args: SendTaskFailureCommandInput,
     options?: __HttpHandlerOptions

package/dist-types/ts3.4/SFNClient.d.ts

@@ -137,6 +137,10 @@ import {
   PublishStateMachineVersionCommandInput,
   PublishStateMachineVersionCommandOutput,
 } from "./commands/PublishStateMachineVersionCommand";
+import {
+  RedriveExecutionCommandInput,
+  RedriveExecutionCommandOutput,
+} from "./commands/RedriveExecutionCommand";
 import {
   SendTaskFailureCommandInput,
   SendTaskFailureCommandOutput,
@@ -212,6 +216,7 @@ export type ServiceInputTypes =
   | ListStateMachinesCommandInput
   | ListTagsForResourceCommandInput
   | PublishStateMachineVersionCommandInput
+  | RedriveExecutionCommandInput
   | SendTaskFailureCommandInput
   | SendTaskHeartbeatCommandInput
   | SendTaskSuccessCommandInput
@@ -247,6 +252,7 @@ export type ServiceOutputTypes =
   | ListStateMachinesCommandOutput
   | ListTagsForResourceCommandOutput
   | PublishStateMachineVersionCommandOutput
+  | RedriveExecutionCommandOutput
   | SendTaskFailureCommandOutput
   | SendTaskHeartbeatCommandOutput
   | SendTaskSuccessCommandOutput

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

@@ -0,0 +1,38 @@
+import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
+import { Command as $Command } from "@smithy/smithy-client";
+import {
+  Handler,
+  HttpHandlerOptions as __HttpHandlerOptions,
+  MetadataBearer as __MetadataBearer,
+  MiddlewareStack,
+} from "@smithy/types";
+import {
+  RedriveExecutionInput,
+  RedriveExecutionOutput,
+} from "../models/models_0";
+import {
+  ServiceInputTypes,
+  ServiceOutputTypes,
+  SFNClientResolvedConfig,
+} from "../SFNClient";
+export { __MetadataBearer, $Command };
+export interface RedriveExecutionCommandInput extends RedriveExecutionInput {}
+export interface RedriveExecutionCommandOutput
+  extends RedriveExecutionOutput,
+    __MetadataBearer {}
+export declare class RedriveExecutionCommand extends $Command<
+  RedriveExecutionCommandInput,
+  RedriveExecutionCommandOutput,
+  SFNClientResolvedConfig
+> {
+  readonly input: RedriveExecutionCommandInput;
+  static getEndpointParameterInstructions(): EndpointParameterInstructions;
+  constructor(input: RedriveExecutionCommandInput);
+  resolveMiddleware(
+    clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>,
+    configuration: SFNClientResolvedConfig,
+    options?: __HttpHandlerOptions
+  ): Handler<RedriveExecutionCommandInput, RedriveExecutionCommandOutput>;
+  private serialize;
+  private deserialize;
+}

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

@@ -21,6 +21,7 @@ export * from "./ListStateMachineVersionsCommand";
 export * from "./ListStateMachinesCommand";
 export * from "./ListTagsForResourceCommand";
 export * from "./PublishStateMachineVersionCommand";
+export * from "./RedriveExecutionCommand";
 export * from "./SendTaskFailureCommand";
 export * from "./SendTaskHeartbeatCommand";
 export * from "./SendTaskSuccessCommand";