@aws-sdk/client-sfn 3.450.0 → 3.451.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +11 -0
- package/dist-cjs/SFN.js +2 -0
- package/dist-cjs/commands/RedriveExecutionCommand.js +51 -0
- package/dist-cjs/commands/index.js +1 -0
- package/dist-cjs/models/models_0.js +41 -15
- package/dist-cjs/protocols/Aws_json1_0.js +82 -2
- package/dist-es/SFN.js +2 -0
- package/dist-es/commands/RedriveExecutionCommand.js +47 -0
- package/dist-es/commands/index.js +1 -0
- package/dist-es/models/models_0.js +37 -12
- package/dist-es/protocols/Aws_json1_0.js +79 -1
- package/dist-types/SFN.d.ts +10 -0
- package/dist-types/SFNClient.d.ts +6 -2
- package/dist-types/commands/DeleteStateMachineCommand.d.ts +2 -2
- package/dist-types/commands/DescribeExecutionCommand.d.ts +7 -6
- package/dist-types/commands/DescribeMapRunCommand.d.ts +7 -1
- package/dist-types/commands/GetExecutionHistoryCommand.d.ts +8 -1
- package/dist-types/commands/ListExecutionsCommand.d.ts +6 -3
- package/dist-types/commands/RedriveExecutionCommand.d.ts +108 -0
- package/dist-types/commands/SendTaskFailureCommand.d.ts +4 -2
- package/dist-types/commands/SendTaskHeartbeatCommand.d.ts +5 -3
- package/dist-types/commands/SendTaskSuccessCommand.d.ts +4 -2
- package/dist-types/commands/index.d.ts +1 -0
- package/dist-types/index.d.ts +3 -0
- package/dist-types/models/models_0.d.ts +238 -14
- package/dist-types/protocols/Aws_json1_0.d.ts +9 -0
- package/dist-types/ts3.4/SFN.d.ts +17 -0
- package/dist-types/ts3.4/SFNClient.d.ts +6 -0
- package/dist-types/ts3.4/commands/RedriveExecutionCommand.d.ts +38 -0
- package/dist-types/ts3.4/commands/index.d.ts +1 -0
- package/dist-types/ts3.4/models/models_0.d.ts +59 -7
- package/dist-types/ts3.4/protocols/Aws_json1_0.d.ts +12 -0
- package/package.json +38 -36
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import { HttpRequest as __HttpRequest, isValidHostname as __isValidHostname, } from "@smithy/protocol-http";
|
|
2
2
|
import { _json, collectBody, decorateServiceException as __decorateServiceException, expectInt32 as __expectInt32, expectLong as __expectLong, expectNonNull as __expectNonNull, expectNumber as __expectNumber, expectString as __expectString, limitedParseFloat32 as __limitedParseFloat32, parseEpochTimestamp as __parseEpochTimestamp, serializeFloat as __serializeFloat, take, withBaseException, } from "@smithy/smithy-client";
|
|
3
|
-
import {
|
|
3
|
+
import { v4 as generateIdempotencyToken } from "uuid";
|
|
4
|
+
import { ActivityDoesNotExist, ActivityLimitExceeded, ActivityWorkerLimitExceeded, ConflictException, ExecutionAlreadyExists, ExecutionDoesNotExist, ExecutionLimitExceeded, ExecutionNotRedrivable, InvalidArn, InvalidDefinition, InvalidExecutionInput, InvalidLoggingConfiguration, InvalidName, InvalidOutput, InvalidToken, InvalidTracingConfiguration, MissingRequiredParameter, ResourceNotFound, ServiceQuotaExceededException, StateMachineAlreadyExists, StateMachineDeleting, StateMachineDoesNotExist, StateMachineLimitExceeded, StateMachineTypeNotSupported, TaskDoesNotExist, TaskTimedOut, TooManyTags, ValidationException, } from "../models/models_0";
|
|
4
5
|
import { SFNServiceException as __BaseException } from "../models/SFNServiceException";
|
|
5
6
|
export const se_CreateActivityCommand = async (input, context) => {
|
|
6
7
|
const headers = sharedHeaders("CreateActivity");
|
|
@@ -140,6 +141,12 @@ export const se_PublishStateMachineVersionCommand = async (input, context) => {
|
|
|
140
141
|
body = JSON.stringify(_json(input));
|
|
141
142
|
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
142
143
|
};
|
|
144
|
+
export const se_RedriveExecutionCommand = async (input, context) => {
|
|
145
|
+
const headers = sharedHeaders("RedriveExecution");
|
|
146
|
+
let body;
|
|
147
|
+
body = JSON.stringify(se_RedriveExecutionInput(input, context));
|
|
148
|
+
return buildHttpRpcRequest(context, headers, "/", undefined, body);
|
|
149
|
+
};
|
|
143
150
|
export const se_SendTaskFailureCommand = async (input, context) => {
|
|
144
151
|
const headers = sharedHeaders("SendTaskFailure");
|
|
145
152
|
let body;
|
|
@@ -1114,6 +1121,47 @@ const de_PublishStateMachineVersionCommandError = async (output, context) => {
|
|
|
1114
1121
|
});
|
|
1115
1122
|
}
|
|
1116
1123
|
};
|
|
1124
|
+
export const de_RedriveExecutionCommand = async (output, context) => {
|
|
1125
|
+
if (output.statusCode >= 300) {
|
|
1126
|
+
return de_RedriveExecutionCommandError(output, context);
|
|
1127
|
+
}
|
|
1128
|
+
const data = await parseBody(output.body, context);
|
|
1129
|
+
let contents = {};
|
|
1130
|
+
contents = de_RedriveExecutionOutput(data, context);
|
|
1131
|
+
const response = {
|
|
1132
|
+
$metadata: deserializeMetadata(output),
|
|
1133
|
+
...contents,
|
|
1134
|
+
};
|
|
1135
|
+
return response;
|
|
1136
|
+
};
|
|
1137
|
+
const de_RedriveExecutionCommandError = async (output, context) => {
|
|
1138
|
+
const parsedOutput = {
|
|
1139
|
+
...output,
|
|
1140
|
+
body: await parseErrorBody(output.body, context),
|
|
1141
|
+
};
|
|
1142
|
+
const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
|
|
1143
|
+
switch (errorCode) {
|
|
1144
|
+
case "ExecutionDoesNotExist":
|
|
1145
|
+
case "com.amazonaws.sfn#ExecutionDoesNotExist":
|
|
1146
|
+
throw await de_ExecutionDoesNotExistRes(parsedOutput, context);
|
|
1147
|
+
case "ExecutionLimitExceeded":
|
|
1148
|
+
case "com.amazonaws.sfn#ExecutionLimitExceeded":
|
|
1149
|
+
throw await de_ExecutionLimitExceededRes(parsedOutput, context);
|
|
1150
|
+
case "ExecutionNotRedrivable":
|
|
1151
|
+
case "com.amazonaws.sfn#ExecutionNotRedrivable":
|
|
1152
|
+
throw await de_ExecutionNotRedrivableRes(parsedOutput, context);
|
|
1153
|
+
case "InvalidArn":
|
|
1154
|
+
case "com.amazonaws.sfn#InvalidArn":
|
|
1155
|
+
throw await de_InvalidArnRes(parsedOutput, context);
|
|
1156
|
+
default:
|
|
1157
|
+
const parsedBody = parsedOutput.body;
|
|
1158
|
+
return throwDefaultError({
|
|
1159
|
+
output,
|
|
1160
|
+
parsedBody,
|
|
1161
|
+
errorCode,
|
|
1162
|
+
});
|
|
1163
|
+
}
|
|
1164
|
+
};
|
|
1117
1165
|
export const de_SendTaskFailureCommand = async (output, context) => {
|
|
1118
1166
|
if (output.statusCode >= 300) {
|
|
1119
1167
|
return de_SendTaskFailureCommandError(output, context);
|
|
@@ -1643,6 +1691,15 @@ const de_ExecutionLimitExceededRes = async (parsedOutput, context) => {
|
|
|
1643
1691
|
});
|
|
1644
1692
|
return __decorateServiceException(exception, body);
|
|
1645
1693
|
};
|
|
1694
|
+
const de_ExecutionNotRedrivableRes = async (parsedOutput, context) => {
|
|
1695
|
+
const body = parsedOutput.body;
|
|
1696
|
+
const deserialized = _json(body);
|
|
1697
|
+
const exception = new ExecutionNotRedrivable({
|
|
1698
|
+
$metadata: deserializeMetadata(parsedOutput),
|
|
1699
|
+
...deserialized,
|
|
1700
|
+
});
|
|
1701
|
+
return __decorateServiceException(exception, body);
|
|
1702
|
+
};
|
|
1646
1703
|
const de_InvalidArnRes = async (parsedOutput, context) => {
|
|
1647
1704
|
const body = parsedOutput.body;
|
|
1648
1705
|
const deserialized = _json(body);
|
|
@@ -1823,6 +1880,12 @@ const de_ValidationExceptionRes = async (parsedOutput, context) => {
|
|
|
1823
1880
|
});
|
|
1824
1881
|
return __decorateServiceException(exception, body);
|
|
1825
1882
|
};
|
|
1883
|
+
const se_RedriveExecutionInput = (input, context) => {
|
|
1884
|
+
return take(input, {
|
|
1885
|
+
clientToken: [true, (_) => _ ?? generateIdempotencyToken()],
|
|
1886
|
+
executionArn: [],
|
|
1887
|
+
});
|
|
1888
|
+
};
|
|
1826
1889
|
const se_UpdateMapRunInput = (input, context) => {
|
|
1827
1890
|
return take(input, {
|
|
1828
1891
|
mapRunArn: [],
|
|
@@ -1883,6 +1946,10 @@ const de_DescribeExecutionOutput = (output, context) => {
|
|
|
1883
1946
|
name: __expectString,
|
|
1884
1947
|
output: __expectString,
|
|
1885
1948
|
outputDetails: _json,
|
|
1949
|
+
redriveCount: __expectInt32,
|
|
1950
|
+
redriveDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1951
|
+
redriveStatus: __expectString,
|
|
1952
|
+
redriveStatusReason: __expectString,
|
|
1886
1953
|
startDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1887
1954
|
stateMachineAliasArn: __expectString,
|
|
1888
1955
|
stateMachineArn: __expectString,
|
|
@@ -1899,6 +1966,8 @@ const de_DescribeMapRunOutput = (output, context) => {
|
|
|
1899
1966
|
itemCounts: _json,
|
|
1900
1967
|
mapRunArn: __expectString,
|
|
1901
1968
|
maxConcurrency: __expectInt32,
|
|
1969
|
+
redriveCount: __expectInt32,
|
|
1970
|
+
redriveDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1902
1971
|
startDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1903
1972
|
status: __expectString,
|
|
1904
1973
|
stopDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
@@ -1960,6 +2029,8 @@ const de_ExecutionListItem = (output, context) => {
|
|
|
1960
2029
|
itemCount: __expectInt32,
|
|
1961
2030
|
mapRunArn: __expectString,
|
|
1962
2031
|
name: __expectString,
|
|
2032
|
+
redriveCount: __expectInt32,
|
|
2033
|
+
redriveDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1963
2034
|
startDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
1964
2035
|
stateMachineAliasArn: __expectString,
|
|
1965
2036
|
stateMachineArn: __expectString,
|
|
@@ -1984,6 +2055,7 @@ const de_HistoryEvent = (output, context) => {
|
|
|
1984
2055
|
activityTimedOutEventDetails: _json,
|
|
1985
2056
|
executionAbortedEventDetails: _json,
|
|
1986
2057
|
executionFailedEventDetails: _json,
|
|
2058
|
+
executionRedrivenEventDetails: _json,
|
|
1987
2059
|
executionStartedEventDetails: _json,
|
|
1988
2060
|
executionSucceededEventDetails: _json,
|
|
1989
2061
|
executionTimedOutEventDetails: _json,
|
|
@@ -1999,6 +2071,7 @@ const de_HistoryEvent = (output, context) => {
|
|
|
1999
2071
|
mapIterationStartedEventDetails: _json,
|
|
2000
2072
|
mapIterationSucceededEventDetails: _json,
|
|
2001
2073
|
mapRunFailedEventDetails: _json,
|
|
2074
|
+
mapRunRedrivenEventDetails: _json,
|
|
2002
2075
|
mapRunStartedEventDetails: _json,
|
|
2003
2076
|
mapStateStartedEventDetails: _json,
|
|
2004
2077
|
previousEventId: __expectLong,
|
|
@@ -2083,6 +2156,11 @@ const de_PublishStateMachineVersionOutput = (output, context) => {
|
|
|
2083
2156
|
stateMachineVersionArn: __expectString,
|
|
2084
2157
|
});
|
|
2085
2158
|
};
|
|
2159
|
+
const de_RedriveExecutionOutput = (output, context) => {
|
|
2160
|
+
return take(output, {
|
|
2161
|
+
redriveDate: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
|
|
2162
|
+
});
|
|
2163
|
+
};
|
|
2086
2164
|
const de_StartExecutionOutput = (output, context) => {
|
|
2087
2165
|
return take(output, {
|
|
2088
2166
|
executionArn: __expectString,
|
package/dist-types/SFN.d.ts
CHANGED
|
@@ -22,6 +22,7 @@ import { ListStateMachinesCommandInput, ListStateMachinesCommandOutput } from ".
|
|
|
22
22
|
import { ListStateMachineVersionsCommandInput, ListStateMachineVersionsCommandOutput } from "./commands/ListStateMachineVersionsCommand";
|
|
23
23
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
24
24
|
import { PublishStateMachineVersionCommandInput, PublishStateMachineVersionCommandOutput } from "./commands/PublishStateMachineVersionCommand";
|
|
25
|
+
import { RedriveExecutionCommandInput, RedriveExecutionCommandOutput } from "./commands/RedriveExecutionCommand";
|
|
25
26
|
import { SendTaskFailureCommandInput, SendTaskFailureCommandOutput } from "./commands/SendTaskFailureCommand";
|
|
26
27
|
import { SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput } from "./commands/SendTaskHeartbeatCommand";
|
|
27
28
|
import { SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput } from "./commands/SendTaskSuccessCommand";
|
|
@@ -173,6 +174,12 @@ export interface SFN {
|
|
|
173
174
|
publishStateMachineVersion(args: PublishStateMachineVersionCommandInput, options?: __HttpHandlerOptions): Promise<PublishStateMachineVersionCommandOutput>;
|
|
174
175
|
publishStateMachineVersion(args: PublishStateMachineVersionCommandInput, cb: (err: any, data?: PublishStateMachineVersionCommandOutput) => void): void;
|
|
175
176
|
publishStateMachineVersion(args: PublishStateMachineVersionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PublishStateMachineVersionCommandOutput) => void): void;
|
|
177
|
+
/**
|
|
178
|
+
* @see {@link RedriveExecutionCommand}
|
|
179
|
+
*/
|
|
180
|
+
redriveExecution(args: RedriveExecutionCommandInput, options?: __HttpHandlerOptions): Promise<RedriveExecutionCommandOutput>;
|
|
181
|
+
redriveExecution(args: RedriveExecutionCommandInput, cb: (err: any, data?: RedriveExecutionCommandOutput) => void): void;
|
|
182
|
+
redriveExecution(args: RedriveExecutionCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RedriveExecutionCommandOutput) => void): void;
|
|
176
183
|
/**
|
|
177
184
|
* @see {@link SendTaskFailureCommand}
|
|
178
185
|
*/
|
|
@@ -258,6 +265,9 @@ export interface SFN {
|
|
|
258
265
|
* For more information about Step Functions, see the <i>
|
|
259
266
|
* <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
|
|
260
267
|
* </i>.</p>
|
|
268
|
+
* <important>
|
|
269
|
+
* <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
|
|
270
|
+
* </important>
|
|
261
271
|
*/
|
|
262
272
|
export declare class SFN extends SFNClient implements SFN {
|
|
263
273
|
}
|
|
@@ -31,6 +31,7 @@ import { ListStateMachinesCommandInput, ListStateMachinesCommandOutput } from ".
|
|
|
31
31
|
import { ListStateMachineVersionsCommandInput, ListStateMachineVersionsCommandOutput } from "./commands/ListStateMachineVersionsCommand";
|
|
32
32
|
import { ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput } from "./commands/ListTagsForResourceCommand";
|
|
33
33
|
import { PublishStateMachineVersionCommandInput, PublishStateMachineVersionCommandOutput } from "./commands/PublishStateMachineVersionCommand";
|
|
34
|
+
import { RedriveExecutionCommandInput, RedriveExecutionCommandOutput } from "./commands/RedriveExecutionCommand";
|
|
34
35
|
import { SendTaskFailureCommandInput, SendTaskFailureCommandOutput } from "./commands/SendTaskFailureCommand";
|
|
35
36
|
import { SendTaskHeartbeatCommandInput, SendTaskHeartbeatCommandOutput } from "./commands/SendTaskHeartbeatCommand";
|
|
36
37
|
import { SendTaskSuccessCommandInput, SendTaskSuccessCommandOutput } from "./commands/SendTaskSuccessCommand";
|
|
@@ -48,11 +49,11 @@ export { __Client };
|
|
|
48
49
|
/**
|
|
49
50
|
* @public
|
|
50
51
|
*/
|
|
51
|
-
export type ServiceInputTypes = CreateActivityCommandInput | CreateStateMachineAliasCommandInput | CreateStateMachineCommandInput | DeleteActivityCommandInput | DeleteStateMachineAliasCommandInput | DeleteStateMachineCommandInput | DeleteStateMachineVersionCommandInput | DescribeActivityCommandInput | DescribeExecutionCommandInput | DescribeMapRunCommandInput | DescribeStateMachineAliasCommandInput | DescribeStateMachineCommandInput | DescribeStateMachineForExecutionCommandInput | GetActivityTaskCommandInput | GetExecutionHistoryCommandInput | ListActivitiesCommandInput | ListExecutionsCommandInput | ListMapRunsCommandInput | ListStateMachineAliasesCommandInput | ListStateMachineVersionsCommandInput | ListStateMachinesCommandInput | ListTagsForResourceCommandInput | PublishStateMachineVersionCommandInput | SendTaskFailureCommandInput | SendTaskHeartbeatCommandInput | SendTaskSuccessCommandInput | StartExecutionCommandInput | StartSyncExecutionCommandInput | StopExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateMapRunCommandInput | UpdateStateMachineAliasCommandInput | UpdateStateMachineCommandInput;
|
|
52
|
+
export type ServiceInputTypes = CreateActivityCommandInput | CreateStateMachineAliasCommandInput | CreateStateMachineCommandInput | DeleteActivityCommandInput | DeleteStateMachineAliasCommandInput | DeleteStateMachineCommandInput | DeleteStateMachineVersionCommandInput | DescribeActivityCommandInput | DescribeExecutionCommandInput | DescribeMapRunCommandInput | DescribeStateMachineAliasCommandInput | DescribeStateMachineCommandInput | DescribeStateMachineForExecutionCommandInput | GetActivityTaskCommandInput | GetExecutionHistoryCommandInput | ListActivitiesCommandInput | ListExecutionsCommandInput | ListMapRunsCommandInput | ListStateMachineAliasesCommandInput | ListStateMachineVersionsCommandInput | ListStateMachinesCommandInput | ListTagsForResourceCommandInput | PublishStateMachineVersionCommandInput | RedriveExecutionCommandInput | SendTaskFailureCommandInput | SendTaskHeartbeatCommandInput | SendTaskSuccessCommandInput | StartExecutionCommandInput | StartSyncExecutionCommandInput | StopExecutionCommandInput | TagResourceCommandInput | UntagResourceCommandInput | UpdateMapRunCommandInput | UpdateStateMachineAliasCommandInput | UpdateStateMachineCommandInput;
|
|
52
53
|
/**
|
|
53
54
|
* @public
|
|
54
55
|
*/
|
|
55
|
-
export type ServiceOutputTypes = CreateActivityCommandOutput | CreateStateMachineAliasCommandOutput | CreateStateMachineCommandOutput | DeleteActivityCommandOutput | DeleteStateMachineAliasCommandOutput | DeleteStateMachineCommandOutput | DeleteStateMachineVersionCommandOutput | DescribeActivityCommandOutput | DescribeExecutionCommandOutput | DescribeMapRunCommandOutput | DescribeStateMachineAliasCommandOutput | DescribeStateMachineCommandOutput | DescribeStateMachineForExecutionCommandOutput | GetActivityTaskCommandOutput | GetExecutionHistoryCommandOutput | ListActivitiesCommandOutput | ListExecutionsCommandOutput | ListMapRunsCommandOutput | ListStateMachineAliasesCommandOutput | ListStateMachineVersionsCommandOutput | ListStateMachinesCommandOutput | ListTagsForResourceCommandOutput | PublishStateMachineVersionCommandOutput | SendTaskFailureCommandOutput | SendTaskHeartbeatCommandOutput | SendTaskSuccessCommandOutput | StartExecutionCommandOutput | StartSyncExecutionCommandOutput | StopExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateMapRunCommandOutput | UpdateStateMachineAliasCommandOutput | UpdateStateMachineCommandOutput;
|
|
56
|
+
export type ServiceOutputTypes = CreateActivityCommandOutput | CreateStateMachineAliasCommandOutput | CreateStateMachineCommandOutput | DeleteActivityCommandOutput | DeleteStateMachineAliasCommandOutput | DeleteStateMachineCommandOutput | DeleteStateMachineVersionCommandOutput | DescribeActivityCommandOutput | DescribeExecutionCommandOutput | DescribeMapRunCommandOutput | DescribeStateMachineAliasCommandOutput | DescribeStateMachineCommandOutput | DescribeStateMachineForExecutionCommandOutput | GetActivityTaskCommandOutput | GetExecutionHistoryCommandOutput | ListActivitiesCommandOutput | ListExecutionsCommandOutput | ListMapRunsCommandOutput | ListStateMachineAliasesCommandOutput | ListStateMachineVersionsCommandOutput | ListStateMachinesCommandOutput | ListTagsForResourceCommandOutput | PublishStateMachineVersionCommandOutput | RedriveExecutionCommandOutput | SendTaskFailureCommandOutput | SendTaskHeartbeatCommandOutput | SendTaskSuccessCommandOutput | StartExecutionCommandOutput | StartSyncExecutionCommandOutput | StopExecutionCommandOutput | TagResourceCommandOutput | UntagResourceCommandOutput | UpdateMapRunCommandOutput | UpdateStateMachineAliasCommandOutput | UpdateStateMachineCommandOutput;
|
|
56
57
|
/**
|
|
57
58
|
* @public
|
|
58
59
|
*/
|
|
@@ -202,6 +203,9 @@ export interface SFNClientResolvedConfig extends SFNClientResolvedConfigType {
|
|
|
202
203
|
* For more information about Step Functions, see the <i>
|
|
203
204
|
* <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
|
|
204
205
|
* </i>.</p>
|
|
206
|
+
* <important>
|
|
207
|
+
* <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
|
|
208
|
+
* </important>
|
|
205
209
|
*/
|
|
206
210
|
export declare class SFNClient extends __Client<__HttpHandlerOptions, ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig> {
|
|
207
211
|
/**
|
|
@@ -23,8 +23,8 @@ export interface DeleteStateMachineCommandOutput extends DeleteStateMachineOutpu
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Deletes a state machine. This is an asynchronous operation
|
|
27
|
-
* status to <code>DELETING</code> and begins the deletion process.
|
|
26
|
+
* <p>Deletes a state machine. This is an asynchronous operation. It sets the state machine's
|
|
27
|
+
* status to <code>DELETING</code> and begins the deletion process. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine's executions are terminated.</p>
|
|
28
28
|
* <p>A qualified state machine ARN can either refer to a <i>Distributed Map state</i> defined within a state machine, a version ARN, or an alias ARN.</p>
|
|
29
29
|
* <p>The following are some examples of qualified and unqualified state machine ARNs:</p>
|
|
30
30
|
* <ul>
|
|
@@ -23,16 +23,13 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Provides information about a state machine execution, such as the state machine
|
|
27
|
-
* associated with the execution, the execution input and output, and relevant execution
|
|
28
|
-
* metadata. Use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was
|
|
29
|
-
* dispatched by a Map Run.</p>
|
|
26
|
+
* <p>Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you've <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html">redriven</a> an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.</p>
|
|
30
27
|
* <p>If you specify a version or alias ARN when you call the <a>StartExecution</a>
|
|
31
28
|
* API action, <code>DescribeExecution</code> returns that ARN.</p>
|
|
32
29
|
* <note>
|
|
33
30
|
* <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
|
|
34
31
|
* </note>
|
|
35
|
-
* <p>Executions of an <code>EXPRESS</code> state
|
|
32
|
+
* <p>Executions of an <code>EXPRESS</code> state machine aren't supported by <code>DescribeExecution</code> unless a Map Run dispatched them.</p>
|
|
36
33
|
* @example
|
|
37
34
|
* Use a bare-bones client and the command you need to make an API call.
|
|
38
35
|
* ```javascript
|
|
@@ -48,7 +45,7 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput,
|
|
|
48
45
|
* // executionArn: "STRING_VALUE", // required
|
|
49
46
|
* // stateMachineArn: "STRING_VALUE", // required
|
|
50
47
|
* // name: "STRING_VALUE",
|
|
51
|
-
* // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED", // required
|
|
48
|
+
* // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED" || "PENDING_REDRIVE", // required
|
|
52
49
|
* // startDate: new Date("TIMESTAMP"), // required
|
|
53
50
|
* // stopDate: new Date("TIMESTAMP"),
|
|
54
51
|
* // input: "STRING_VALUE",
|
|
@@ -65,6 +62,10 @@ export interface DescribeExecutionCommandOutput extends DescribeExecutionOutput,
|
|
|
65
62
|
* // cause: "STRING_VALUE",
|
|
66
63
|
* // stateMachineVersionArn: "STRING_VALUE",
|
|
67
64
|
* // stateMachineAliasArn: "STRING_VALUE",
|
|
65
|
+
* // redriveCount: Number("int"),
|
|
66
|
+
* // redriveDate: new Date("TIMESTAMP"),
|
|
67
|
+
* // redriveStatus: "REDRIVABLE" || "NOT_REDRIVABLE" || "REDRIVABLE_BY_MAP_RUN",
|
|
68
|
+
* // redriveStatusReason: "STRING_VALUE",
|
|
68
69
|
* // };
|
|
69
70
|
*
|
|
70
71
|
* ```
|
|
@@ -23,7 +23,7 @@ export interface DescribeMapRunCommandOutput extends DescribeMapRunOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Provides information about a Map Run's configuration, progress, and results. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
26
|
+
* <p>Provides information about a Map Run's configuration, progress, and results. If you've <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">redriven</a> a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html">Examining Map Run</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
27
27
|
* @example
|
|
28
28
|
* Use a bare-bones client and the command you need to make an API call.
|
|
29
29
|
* ```javascript
|
|
@@ -53,6 +53,8 @@ export interface DescribeMapRunCommandOutput extends DescribeMapRunOutput, __Met
|
|
|
53
53
|
* // aborted: Number("long"), // required
|
|
54
54
|
* // total: Number("long"), // required
|
|
55
55
|
* // resultsWritten: Number("long"), // required
|
|
56
|
+
* // failuresNotRedrivable: Number("long"),
|
|
57
|
+
* // pendingRedrive: Number("long"),
|
|
56
58
|
* // },
|
|
57
59
|
* // executionCounts: { // MapRunExecutionCounts
|
|
58
60
|
* // pending: Number("long"), // required
|
|
@@ -63,7 +65,11 @@ export interface DescribeMapRunCommandOutput extends DescribeMapRunOutput, __Met
|
|
|
63
65
|
* // aborted: Number("long"), // required
|
|
64
66
|
* // total: Number("long"), // required
|
|
65
67
|
* // resultsWritten: Number("long"), // required
|
|
68
|
+
* // failuresNotRedrivable: Number("long"),
|
|
69
|
+
* // pendingRedrive: Number("long"),
|
|
66
70
|
* // },
|
|
71
|
+
* // redriveCount: Number("int"),
|
|
72
|
+
* // redriveDate: new Date("TIMESTAMP"),
|
|
67
73
|
* // };
|
|
68
74
|
*
|
|
69
75
|
* ```
|
|
@@ -48,7 +48,7 @@ export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOut
|
|
|
48
48
|
* // events: [ // HistoryEventList // required
|
|
49
49
|
* // { // HistoryEvent
|
|
50
50
|
* // timestamp: new Date("TIMESTAMP"), // required
|
|
51
|
-
* // type: "ActivityFailed" || "ActivityScheduled" || "ActivityScheduleFailed" || "ActivityStarted" || "ActivitySucceeded" || "ActivityTimedOut" || "ChoiceStateEntered" || "ChoiceStateExited" || "ExecutionAborted" || "ExecutionFailed" || "ExecutionStarted" || "ExecutionSucceeded" || "ExecutionTimedOut" || "FailStateEntered" || "LambdaFunctionFailed" || "LambdaFunctionScheduled" || "LambdaFunctionScheduleFailed" || "LambdaFunctionStarted" || "LambdaFunctionStartFailed" || "LambdaFunctionSucceeded" || "LambdaFunctionTimedOut" || "MapIterationAborted" || "MapIterationFailed" || "MapIterationStarted" || "MapIterationSucceeded" || "MapStateAborted" || "MapStateEntered" || "MapStateExited" || "MapStateFailed" || "MapStateStarted" || "MapStateSucceeded" || "ParallelStateAborted" || "ParallelStateEntered" || "ParallelStateExited" || "ParallelStateFailed" || "ParallelStateStarted" || "ParallelStateSucceeded" || "PassStateEntered" || "PassStateExited" || "SucceedStateEntered" || "SucceedStateExited" || "TaskFailed" || "TaskScheduled" || "TaskStarted" || "TaskStartFailed" || "TaskStateAborted" || "TaskStateEntered" || "TaskStateExited" || "TaskSubmitFailed" || "TaskSubmitted" || "TaskSucceeded" || "TaskTimedOut" || "WaitStateAborted" || "WaitStateEntered" || "WaitStateExited" || "MapRunAborted" || "MapRunFailed" || "MapRunStarted" || "MapRunSucceeded", // required
|
|
51
|
+
* // type: "ActivityFailed" || "ActivityScheduled" || "ActivityScheduleFailed" || "ActivityStarted" || "ActivitySucceeded" || "ActivityTimedOut" || "ChoiceStateEntered" || "ChoiceStateExited" || "ExecutionAborted" || "ExecutionFailed" || "ExecutionStarted" || "ExecutionSucceeded" || "ExecutionTimedOut" || "FailStateEntered" || "LambdaFunctionFailed" || "LambdaFunctionScheduled" || "LambdaFunctionScheduleFailed" || "LambdaFunctionStarted" || "LambdaFunctionStartFailed" || "LambdaFunctionSucceeded" || "LambdaFunctionTimedOut" || "MapIterationAborted" || "MapIterationFailed" || "MapIterationStarted" || "MapIterationSucceeded" || "MapStateAborted" || "MapStateEntered" || "MapStateExited" || "MapStateFailed" || "MapStateStarted" || "MapStateSucceeded" || "ParallelStateAborted" || "ParallelStateEntered" || "ParallelStateExited" || "ParallelStateFailed" || "ParallelStateStarted" || "ParallelStateSucceeded" || "PassStateEntered" || "PassStateExited" || "SucceedStateEntered" || "SucceedStateExited" || "TaskFailed" || "TaskScheduled" || "TaskStarted" || "TaskStartFailed" || "TaskStateAborted" || "TaskStateEntered" || "TaskStateExited" || "TaskSubmitFailed" || "TaskSubmitted" || "TaskSucceeded" || "TaskTimedOut" || "WaitStateAborted" || "WaitStateEntered" || "WaitStateExited" || "MapRunAborted" || "MapRunFailed" || "MapRunStarted" || "MapRunSucceeded" || "ExecutionRedriven" || "MapRunRedriven", // required
|
|
52
52
|
* // id: Number("long"), // required
|
|
53
53
|
* // previousEventId: Number("long"),
|
|
54
54
|
* // activityFailedEventDetails: { // ActivityFailedEventDetails
|
|
@@ -161,6 +161,9 @@ export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOut
|
|
|
161
161
|
* // error: "STRING_VALUE",
|
|
162
162
|
* // cause: "STRING_VALUE",
|
|
163
163
|
* // },
|
|
164
|
+
* // executionRedrivenEventDetails: { // ExecutionRedrivenEventDetails
|
|
165
|
+
* // redriveCount: Number("int"),
|
|
166
|
+
* // },
|
|
164
167
|
* // mapStateStartedEventDetails: { // MapStateStartedEventDetails
|
|
165
168
|
* // length: Number("int"),
|
|
166
169
|
* // },
|
|
@@ -226,6 +229,10 @@ export interface GetExecutionHistoryCommandOutput extends GetExecutionHistoryOut
|
|
|
226
229
|
* // error: "STRING_VALUE",
|
|
227
230
|
* // cause: "STRING_VALUE",
|
|
228
231
|
* // },
|
|
232
|
+
* // mapRunRedrivenEventDetails: { // MapRunRedrivenEventDetails
|
|
233
|
+
* // mapRunArn: "STRING_VALUE",
|
|
234
|
+
* // redriveCount: Number("int"),
|
|
235
|
+
* // },
|
|
229
236
|
* // },
|
|
230
237
|
* // ],
|
|
231
238
|
* // nextToken: "STRING_VALUE",
|
|
@@ -23,7 +23,7 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN.</p>
|
|
26
|
+
* <p>Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html">redriven</a> executions.</p>
|
|
27
27
|
* <p>You can also provide a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a> ARN or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a> ARN to list the executions associated with a specific alias or version.</p>
|
|
28
28
|
* <p>Results are
|
|
29
29
|
* sorted by time, with the most recent execution first.</p>
|
|
@@ -41,10 +41,11 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
|
|
|
41
41
|
* const client = new SFNClient(config);
|
|
42
42
|
* const input = { // ListExecutionsInput
|
|
43
43
|
* stateMachineArn: "STRING_VALUE",
|
|
44
|
-
* statusFilter: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED",
|
|
44
|
+
* statusFilter: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED" || "PENDING_REDRIVE",
|
|
45
45
|
* maxResults: Number("int"),
|
|
46
46
|
* nextToken: "STRING_VALUE",
|
|
47
47
|
* mapRunArn: "STRING_VALUE",
|
|
48
|
+
* redriveFilter: "REDRIVEN" || "NOT_REDRIVEN",
|
|
48
49
|
* };
|
|
49
50
|
* const command = new ListExecutionsCommand(input);
|
|
50
51
|
* const response = await client.send(command);
|
|
@@ -54,13 +55,15 @@ export interface ListExecutionsCommandOutput extends ListExecutionsOutput, __Met
|
|
|
54
55
|
* // executionArn: "STRING_VALUE", // required
|
|
55
56
|
* // stateMachineArn: "STRING_VALUE", // required
|
|
56
57
|
* // name: "STRING_VALUE", // required
|
|
57
|
-
* // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED", // required
|
|
58
|
+
* // status: "RUNNING" || "SUCCEEDED" || "FAILED" || "TIMED_OUT" || "ABORTED" || "PENDING_REDRIVE", // required
|
|
58
59
|
* // startDate: new Date("TIMESTAMP"), // required
|
|
59
60
|
* // stopDate: new Date("TIMESTAMP"),
|
|
60
61
|
* // mapRunArn: "STRING_VALUE",
|
|
61
62
|
* // itemCount: Number("int"),
|
|
62
63
|
* // stateMachineVersionArn: "STRING_VALUE",
|
|
63
64
|
* // stateMachineAliasArn: "STRING_VALUE",
|
|
65
|
+
* // redriveCount: Number("int"),
|
|
66
|
+
* // redriveDate: new Date("TIMESTAMP"),
|
|
64
67
|
* // },
|
|
65
68
|
* // ],
|
|
66
69
|
* // nextToken: "STRING_VALUE",
|
|
@@ -0,0 +1,108 @@
|
|
|
1
|
+
import { EndpointParameterInstructions } from "@smithy/middleware-endpoint";
|
|
2
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
3
|
+
import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@smithy/types";
|
|
4
|
+
import { RedriveExecutionInput, RedriveExecutionOutput } from "../models/models_0";
|
|
5
|
+
import { ServiceInputTypes, ServiceOutputTypes, SFNClientResolvedConfig } from "../SFNClient";
|
|
6
|
+
/**
|
|
7
|
+
* @public
|
|
8
|
+
*/
|
|
9
|
+
export { __MetadataBearer, $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link RedriveExecutionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RedriveExecutionCommandInput extends RedriveExecutionInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RedriveExecutionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RedriveExecutionCommandOutput extends RedriveExecutionOutput, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* @public
|
|
26
|
+
* <p>Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html">redrive</a> an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn't rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.</p>
|
|
27
|
+
* <p>For workflows that include an <a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html">Inline Map</a> or <a href="https://docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html">Parallel</a> state, <code>RedriveExecution</code> API action reschedules and redrives only the iterations and branches that failed or aborted.</p>
|
|
28
|
+
* <p>To redrive a workflow that includes a Distributed Map state with failed child workflow executions, you must redrive the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/use-dist-map-orchestrate-large-scale-parallel-workloads.html#dist-map-orchestrate-parallel-workloads-key-terms">parent workflow</a>. The parent workflow redrives all the unsuccessful states, including Distributed Map.</p>
|
|
29
|
+
* <note>
|
|
30
|
+
* <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
|
|
31
|
+
* <p>However, you can restart the unsuccessful executions of Express child workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the <a>StartExecution</a> API action. For more information, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html">Redriving Map Runs</a>.</p>
|
|
32
|
+
* </note>
|
|
33
|
+
* <p>You can redrive executions if your original execution meets the following conditions:</p>
|
|
34
|
+
* <ul>
|
|
35
|
+
* <li>
|
|
36
|
+
* <p>The execution status isn't <code>SUCCEEDED</code>.</p>
|
|
37
|
+
* </li>
|
|
38
|
+
* <li>
|
|
39
|
+
* <p>Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.</p>
|
|
40
|
+
* </li>
|
|
41
|
+
* <li>
|
|
42
|
+
* <p>The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits-overview.html#service-limits-state-machine-executions">Quotas related to state machine executions</a>.</p>
|
|
43
|
+
* </li>
|
|
44
|
+
* <li>
|
|
45
|
+
* <p>The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the <code>ExecutionRedriven</code> history event and at least one other history event.</p>
|
|
46
|
+
* </li>
|
|
47
|
+
* </ul>
|
|
48
|
+
* @example
|
|
49
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
50
|
+
* ```javascript
|
|
51
|
+
* import { SFNClient, RedriveExecutionCommand } from "@aws-sdk/client-sfn"; // ES Modules import
|
|
52
|
+
* // const { SFNClient, RedriveExecutionCommand } = require("@aws-sdk/client-sfn"); // CommonJS import
|
|
53
|
+
* const client = new SFNClient(config);
|
|
54
|
+
* const input = { // RedriveExecutionInput
|
|
55
|
+
* executionArn: "STRING_VALUE", // required
|
|
56
|
+
* clientToken: "STRING_VALUE",
|
|
57
|
+
* };
|
|
58
|
+
* const command = new RedriveExecutionCommand(input);
|
|
59
|
+
* const response = await client.send(command);
|
|
60
|
+
* // { // RedriveExecutionOutput
|
|
61
|
+
* // redriveDate: new Date("TIMESTAMP"), // required
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param RedriveExecutionCommandInput - {@link RedriveExecutionCommandInput}
|
|
67
|
+
* @returns {@link RedriveExecutionCommandOutput}
|
|
68
|
+
* @see {@link RedriveExecutionCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link RedriveExecutionCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link SFNClientResolvedConfig | config} for SFNClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link ExecutionDoesNotExist} (client fault)
|
|
73
|
+
* <p>The specified execution does not exist.</p>
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link ExecutionLimitExceeded} (client fault)
|
|
76
|
+
* <p>The maximum number of running executions has been reached. Running executions must end or
|
|
77
|
+
* be stopped before a new execution can be started.</p>
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ExecutionNotRedrivable} (client fault)
|
|
80
|
+
* <p>The execution Amazon Resource Name (ARN) that you specified for <code>executionArn</code> cannot be redriven.</p>
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link InvalidArn} (client fault)
|
|
83
|
+
* <p>The provided Amazon Resource Name (ARN) is not valid.</p>
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link SFNServiceException}
|
|
86
|
+
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
87
|
+
*
|
|
88
|
+
*/
|
|
89
|
+
export declare class RedriveExecutionCommand extends $Command<RedriveExecutionCommandInput, RedriveExecutionCommandOutput, SFNClientResolvedConfig> {
|
|
90
|
+
readonly input: RedriveExecutionCommandInput;
|
|
91
|
+
static getEndpointParameterInstructions(): EndpointParameterInstructions;
|
|
92
|
+
/**
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
constructor(input: RedriveExecutionCommandInput);
|
|
96
|
+
/**
|
|
97
|
+
* @internal
|
|
98
|
+
*/
|
|
99
|
+
resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: SFNClientResolvedConfig, options?: __HttpHandlerOptions): Handler<RedriveExecutionCommandInput, RedriveExecutionCommandOutput>;
|
|
100
|
+
/**
|
|
101
|
+
* @internal
|
|
102
|
+
*/
|
|
103
|
+
private serialize;
|
|
104
|
+
/**
|
|
105
|
+
* @internal
|
|
106
|
+
*/
|
|
107
|
+
private deserialize;
|
|
108
|
+
}
|
|
@@ -23,8 +23,8 @@ export interface SendTaskFailureCommandOutput extends SendTaskFailureOutput, __M
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Used by activity workers
|
|
27
|
-
* pattern to report that the task identified by the <code>taskToken</code> failed.</p>
|
|
26
|
+
* <p>Used by activity workers, Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
|
|
27
|
+
* pattern, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report that the task identified by the <code>taskToken</code> failed.</p>
|
|
28
28
|
* @example
|
|
29
29
|
* Use a bare-bones client and the command you need to make an API call.
|
|
30
30
|
* ```javascript
|
|
@@ -52,8 +52,10 @@ export interface SendTaskFailureCommandOutput extends SendTaskFailureOutput, __M
|
|
|
52
52
|
* <p>The provided token is not valid.</p>
|
|
53
53
|
*
|
|
54
54
|
* @throws {@link TaskDoesNotExist} (client fault)
|
|
55
|
+
* <p>The activity does not exist.</p>
|
|
55
56
|
*
|
|
56
57
|
* @throws {@link TaskTimedOut} (client fault)
|
|
58
|
+
* <p>The task token has either expired or the task associated with the token has already been closed.</p>
|
|
57
59
|
*
|
|
58
60
|
* @throws {@link SFNServiceException}
|
|
59
61
|
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
@@ -23,14 +23,14 @@ export interface SendTaskHeartbeatCommandOutput extends SendTaskHeartbeatOutput,
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Used by activity workers and
|
|
27
|
-
* pattern to report to Step Functions that the task represented by the specified
|
|
26
|
+
* <p>Used by activity workers and Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
|
|
27
|
+
* pattern, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report to Step Functions that the task represented by the specified
|
|
28
28
|
* <code>taskToken</code> is still making progress. This action resets the
|
|
29
29
|
* <code>Heartbeat</code> clock. The <code>Heartbeat</code> threshold is specified in the state
|
|
30
30
|
* machine's Amazon States Language definition (<code>HeartbeatSeconds</code>). This action does not in itself
|
|
31
31
|
* create an event in the execution history. However, if the task times out, the execution
|
|
32
32
|
* history contains an <code>ActivityTimedOut</code> entry for activities, or a
|
|
33
|
-
* <code>TaskTimedOut</code> entry for
|
|
33
|
+
* <code>TaskTimedOut</code> entry for tasks using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> or
|
|
34
34
|
* <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
|
|
35
35
|
* pattern.</p>
|
|
36
36
|
* <note>
|
|
@@ -63,8 +63,10 @@ export interface SendTaskHeartbeatCommandOutput extends SendTaskHeartbeatOutput,
|
|
|
63
63
|
* <p>The provided token is not valid.</p>
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link TaskDoesNotExist} (client fault)
|
|
66
|
+
* <p>The activity does not exist.</p>
|
|
66
67
|
*
|
|
67
68
|
* @throws {@link TaskTimedOut} (client fault)
|
|
69
|
+
* <p>The task token has either expired or the task associated with the token has already been closed.</p>
|
|
68
70
|
*
|
|
69
71
|
* @throws {@link SFNServiceException}
|
|
70
72
|
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
@@ -23,8 +23,8 @@ export interface SendTaskSuccessCommandOutput extends SendTaskSuccessOutput, __M
|
|
|
23
23
|
}
|
|
24
24
|
/**
|
|
25
25
|
* @public
|
|
26
|
-
* <p>Used by activity workers
|
|
27
|
-
* pattern to report that the task identified by the <code>taskToken</code> completed
|
|
26
|
+
* <p>Used by activity workers, Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
|
|
27
|
+
* pattern, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report that the task identified by the <code>taskToken</code> completed
|
|
28
28
|
* successfully.</p>
|
|
29
29
|
* @example
|
|
30
30
|
* Use a bare-bones client and the command you need to make an API call.
|
|
@@ -55,8 +55,10 @@ export interface SendTaskSuccessCommandOutput extends SendTaskSuccessOutput, __M
|
|
|
55
55
|
* <p>The provided token is not valid.</p>
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link TaskDoesNotExist} (client fault)
|
|
58
|
+
* <p>The activity does not exist.</p>
|
|
58
59
|
*
|
|
59
60
|
* @throws {@link TaskTimedOut} (client fault)
|
|
61
|
+
* <p>The task token has either expired or the task associated with the token has already been closed.</p>
|
|
60
62
|
*
|
|
61
63
|
* @throws {@link SFNServiceException}
|
|
62
64
|
* <p>Base exception class for all service exceptions from SFN service.</p>
|
|
@@ -21,6 +21,7 @@ export * from "./ListStateMachineVersionsCommand";
|
|
|
21
21
|
export * from "./ListStateMachinesCommand";
|
|
22
22
|
export * from "./ListTagsForResourceCommand";
|
|
23
23
|
export * from "./PublishStateMachineVersionCommand";
|
|
24
|
+
export * from "./RedriveExecutionCommand";
|
|
24
25
|
export * from "./SendTaskFailureCommand";
|
|
25
26
|
export * from "./SendTaskHeartbeatCommand";
|
|
26
27
|
export * from "./SendTaskSuccessCommand";
|
package/dist-types/index.d.ts
CHANGED
|
@@ -15,6 +15,9 @@
|
|
|
15
15
|
* For more information about Step Functions, see the <i>
|
|
16
16
|
* <a href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">Step Functions Developer Guide</a>
|
|
17
17
|
* </i>.</p>
|
|
18
|
+
* <important>
|
|
19
|
+
* <p>If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action <code>startSyncExecution</code> and specify its parameter as <code>StateMachineArn</code>.</p>
|
|
20
|
+
* </important>
|
|
18
21
|
*
|
|
19
22
|
* @packageDocumentation
|
|
20
23
|
*/
|