@aws-sdk/client-sfn 3.212.0 → 3.214.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 +5 -5
- package/dist-cjs/models/models_0.js +96 -3
- package/dist-cjs/protocols/Aws_json1_0.js +11 -0
- package/dist-es/models/models_0.js +92 -0
- package/dist-es/protocols/Aws_json1_0.js +11 -0
- package/dist-types/SFN.d.ts +38 -18
- package/dist-types/SFNClient.d.ts +5 -5
- package/dist-types/commands/CreateActivityCommand.d.ts +1 -1
- package/dist-types/commands/CreateStateMachineCommand.d.ts +5 -4
- package/dist-types/commands/DeleteStateMachineCommand.d.ts +1 -1
- package/dist-types/commands/GetActivityTaskCommand.d.ts +5 -0
- package/dist-types/commands/StartExecutionCommand.d.ts +7 -5
- package/dist-types/commands/StartSyncExecutionCommand.d.ts +13 -1
- package/dist-types/commands/TagResourceCommand.d.ts +1 -1
- package/dist-types/models/models_0.d.ts +167 -65
- package/dist-types/ts3.4/models/models_0.d.ts +91 -66
- package/package.json +2 -2
|
@@ -8,7 +8,19 @@ export interface StartSyncExecutionCommandInput extends StartSyncExecutionInput
|
|
|
8
8
|
export interface StartSyncExecutionCommandOutput extends StartSyncExecutionOutput, __MetadataBearer {
|
|
9
9
|
}
|
|
10
10
|
/**
|
|
11
|
-
* <p>Starts a Synchronous Express state machine execution
|
|
11
|
+
* <p>Starts a Synchronous Express state machine execution. <code>StartSyncExecution</code>
|
|
12
|
+
* is not available for <code>STANDARD</code> workflows.</p>
|
|
13
|
+
* <note>
|
|
14
|
+
* <p>
|
|
15
|
+
* <code>StartSyncExecution</code> will return a <code>200 OK</code> response, even if your
|
|
16
|
+
* execution fails, because the status code in the API response doesn't reflect function
|
|
17
|
+
* errors. Error codes are reserved for errors that prevent your execution from running, such
|
|
18
|
+
* as permissions errors, limit errors, or issues with your state machine code and
|
|
19
|
+
* configuration. </p>
|
|
20
|
+
* </note>
|
|
21
|
+
* <note>
|
|
22
|
+
* <p>This API action isn't logged in CloudTrail.</p>
|
|
23
|
+
* </note>
|
|
12
24
|
* @example
|
|
13
25
|
* Use a bare-bones client and the command you need to make an API call.
|
|
14
26
|
* ```javascript
|
|
@@ -10,7 +10,7 @@ export interface TagResourceCommandOutput extends TagResourceOutput, __MetadataB
|
|
|
10
10
|
/**
|
|
11
11
|
* <p>Add a tag to a Step Functions resource.</p>
|
|
12
12
|
* <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
|
|
13
|
-
* Cost Allocation Tags</a> in the <i>
|
|
13
|
+
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
14
14
|
* Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
|
|
15
15
|
* Tags</a>.</p>
|
|
16
16
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
@@ -80,8 +80,8 @@ export interface ActivityListItem {
|
|
|
80
80
|
*/
|
|
81
81
|
export interface HistoryEventExecutionDataDetails {
|
|
82
82
|
/**
|
|
83
|
-
* <p>Indicates whether input or output was truncated in the response. Always
|
|
84
|
-
*
|
|
83
|
+
* <p>Indicates whether input or output was truncated in the response. Always <code>false</code>
|
|
84
|
+
* for API calls.</p>
|
|
85
85
|
*/
|
|
86
86
|
truncated?: boolean;
|
|
87
87
|
}
|
|
@@ -177,7 +177,7 @@ export declare class ActivityWorkerLimitExceeded extends __BaseException {
|
|
|
177
177
|
* <p>Tags are key-value pairs that can be associated with Step Functions state machines and
|
|
178
178
|
* activities.</p>
|
|
179
179
|
* <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
|
|
180
|
-
* Cost Allocation Tags</a> in the <i>
|
|
180
|
+
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
181
181
|
* Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
|
|
182
182
|
* Tags</a>.</p>
|
|
183
183
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
@@ -194,9 +194,9 @@ export interface Tag {
|
|
|
194
194
|
}
|
|
195
195
|
export interface CreateActivityInput {
|
|
196
196
|
/**
|
|
197
|
-
* <p>The name of the activity to create. This name must be unique for your
|
|
197
|
+
* <p>The name of the activity to create. This name must be unique for your Amazon Web Services account and region for 90 days. For more information,
|
|
198
198
|
* see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
|
|
199
|
-
* Limits Related to State Machine Executions</a> in the <i>
|
|
199
|
+
* Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
200
200
|
* <p>A name must <i>not</i> contain:</p>
|
|
201
201
|
* <ul>
|
|
202
202
|
* <li>
|
|
@@ -224,7 +224,7 @@ export interface CreateActivityInput {
|
|
|
224
224
|
/**
|
|
225
225
|
* <p>The list of tags to add to a resource.</p>
|
|
226
226
|
* <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
|
|
227
|
-
* Cost Allocation Tags</a> in the <i>
|
|
227
|
+
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
228
228
|
* Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
|
|
229
229
|
* Tags</a>.</p>
|
|
230
230
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
@@ -254,7 +254,7 @@ export declare class InvalidName extends __BaseException {
|
|
|
254
254
|
}
|
|
255
255
|
/**
|
|
256
256
|
* <p>You've exceeded the number of tags allowed for a resource. See the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html"> Limits Topic</a> in the
|
|
257
|
-
*
|
|
257
|
+
* Step Functions Developer Guide.</p>
|
|
258
258
|
*/
|
|
259
259
|
export declare class TooManyTags extends __BaseException {
|
|
260
260
|
readonly name: "TooManyTags";
|
|
@@ -281,11 +281,16 @@ export interface CloudWatchLogsLogGroup {
|
|
|
281
281
|
*/
|
|
282
282
|
export interface LogDestination {
|
|
283
283
|
/**
|
|
284
|
-
* <p>An object describing a CloudWatch log group. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html">AWS::Logs::LogGroup</a> in the
|
|
284
|
+
* <p>An object describing a CloudWatch log group. For more information, see <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-logs-loggroup.html">AWS::Logs::LogGroup</a> in the CloudFormation User Guide.</p>
|
|
285
285
|
*/
|
|
286
286
|
cloudWatchLogsLogGroup?: CloudWatchLogsLogGroup;
|
|
287
287
|
}
|
|
288
|
-
export declare
|
|
288
|
+
export declare enum LogLevel {
|
|
289
|
+
ALL = "ALL",
|
|
290
|
+
ERROR = "ERROR",
|
|
291
|
+
FATAL = "FATAL",
|
|
292
|
+
OFF = "OFF"
|
|
293
|
+
}
|
|
289
294
|
/**
|
|
290
295
|
* <p>The <code>LoggingConfiguration</code> data type is used to set CloudWatch Logs
|
|
291
296
|
* options.</p>
|
|
@@ -307,16 +312,20 @@ export interface LoggingConfiguration {
|
|
|
307
312
|
destinations?: LogDestination[];
|
|
308
313
|
}
|
|
309
314
|
/**
|
|
310
|
-
* <p>Selects whether or not the state machine's
|
|
315
|
+
* <p>Selects whether or not the state machine's X-Ray tracing is enabled. Default is
|
|
316
|
+
* <code>false</code>
|
|
311
317
|
* </p>
|
|
312
318
|
*/
|
|
313
319
|
export interface TracingConfiguration {
|
|
314
320
|
/**
|
|
315
|
-
* <p>When set to <code>true</code>,
|
|
321
|
+
* <p>When set to <code>true</code>, X-Ray tracing is enabled.</p>
|
|
316
322
|
*/
|
|
317
323
|
enabled?: boolean;
|
|
318
324
|
}
|
|
319
|
-
export declare
|
|
325
|
+
export declare enum StateMachineType {
|
|
326
|
+
EXPRESS = "EXPRESS",
|
|
327
|
+
STANDARD = "STANDARD"
|
|
328
|
+
}
|
|
320
329
|
export interface CreateStateMachineInput {
|
|
321
330
|
/**
|
|
322
331
|
* <p>The name of the state machine. </p>
|
|
@@ -363,21 +372,21 @@ export interface CreateStateMachineInput {
|
|
|
363
372
|
* <note>
|
|
364
373
|
* <p>By default, the <code>level</code> is set to <code>OFF</code>. For more information see
|
|
365
374
|
* <a href="https://docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html">Log
|
|
366
|
-
* Levels</a> in the
|
|
375
|
+
* Levels</a> in the Step Functions User Guide.</p>
|
|
367
376
|
* </note>
|
|
368
377
|
*/
|
|
369
378
|
loggingConfiguration?: LoggingConfiguration;
|
|
370
379
|
/**
|
|
371
380
|
* <p>Tags to be added when creating a state machine.</p>
|
|
372
381
|
* <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
|
|
373
|
-
* Cost Allocation Tags</a> in the <i>
|
|
382
|
+
* Cost Allocation Tags</a> in the <i>Amazon Web Services Billing and Cost Management User
|
|
374
383
|
* Guide</i>, and <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html">Controlling Access Using IAM
|
|
375
384
|
* Tags</a>.</p>
|
|
376
385
|
* <p>Tags may only contain Unicode letters, digits, white space, or these symbols: <code>_ . : / = + - @</code>.</p>
|
|
377
386
|
*/
|
|
378
387
|
tags?: Tag[];
|
|
379
388
|
/**
|
|
380
|
-
* <p>Selects whether
|
|
389
|
+
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
381
390
|
*/
|
|
382
391
|
tracingConfiguration?: TracingConfiguration;
|
|
383
392
|
}
|
|
@@ -425,7 +434,8 @@ export declare class InvalidLoggingConfiguration extends __BaseException {
|
|
|
425
434
|
constructor(opts: __ExceptionOptionType<InvalidLoggingConfiguration, __BaseException>);
|
|
426
435
|
}
|
|
427
436
|
/**
|
|
428
|
-
* <p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not
|
|
437
|
+
* <p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not
|
|
438
|
+
* been set to <code>true</code> or <code>false</code>.</p>
|
|
429
439
|
*/
|
|
430
440
|
export declare class InvalidTracingConfiguration extends __BaseException {
|
|
431
441
|
readonly name: "InvalidTracingConfiguration";
|
|
@@ -555,7 +565,13 @@ export interface CloudWatchEventsExecutionDataDetails {
|
|
|
555
565
|
*/
|
|
556
566
|
included?: boolean;
|
|
557
567
|
}
|
|
558
|
-
export declare
|
|
568
|
+
export declare enum ExecutionStatus {
|
|
569
|
+
ABORTED = "ABORTED",
|
|
570
|
+
FAILED = "FAILED",
|
|
571
|
+
RUNNING = "RUNNING",
|
|
572
|
+
SUCCEEDED = "SUCCEEDED",
|
|
573
|
+
TIMED_OUT = "TIMED_OUT"
|
|
574
|
+
}
|
|
559
575
|
export interface DescribeExecutionOutput {
|
|
560
576
|
/**
|
|
561
577
|
* <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
|
|
@@ -624,7 +640,7 @@ export interface DescribeExecutionOutput {
|
|
|
624
640
|
*/
|
|
625
641
|
outputDetails?: CloudWatchEventsExecutionDataDetails;
|
|
626
642
|
/**
|
|
627
|
-
* <p>The
|
|
643
|
+
* <p>The X-Ray trace header that was passed to the execution.</p>
|
|
628
644
|
*/
|
|
629
645
|
traceHeader?: string;
|
|
630
646
|
}
|
|
@@ -645,7 +661,10 @@ export interface DescribeStateMachineInput {
|
|
|
645
661
|
*/
|
|
646
662
|
stateMachineArn: string | undefined;
|
|
647
663
|
}
|
|
648
|
-
export declare
|
|
664
|
+
export declare enum StateMachineStatus {
|
|
665
|
+
ACTIVE = "ACTIVE",
|
|
666
|
+
DELETING = "DELETING"
|
|
667
|
+
}
|
|
649
668
|
export interface DescribeStateMachineOutput {
|
|
650
669
|
/**
|
|
651
670
|
* <p>The Amazon Resource Name (ARN) that identifies the state machine.</p>
|
|
@@ -687,7 +706,7 @@ export interface DescribeStateMachineOutput {
|
|
|
687
706
|
definition: string | undefined;
|
|
688
707
|
/**
|
|
689
708
|
* <p>The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role
|
|
690
|
-
* maintains security by granting Step Functions access to
|
|
709
|
+
* maintains security by granting Step Functions access to Amazon Web Services resources.)</p>
|
|
691
710
|
*/
|
|
692
711
|
roleArn: string | undefined;
|
|
693
712
|
/**
|
|
@@ -705,7 +724,7 @@ export interface DescribeStateMachineOutput {
|
|
|
705
724
|
*/
|
|
706
725
|
loggingConfiguration?: LoggingConfiguration;
|
|
707
726
|
/**
|
|
708
|
-
* <p>Selects whether
|
|
727
|
+
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
709
728
|
*/
|
|
710
729
|
tracingConfiguration?: TracingConfiguration;
|
|
711
730
|
}
|
|
@@ -754,7 +773,7 @@ export interface DescribeStateMachineForExecutionOutput {
|
|
|
754
773
|
*/
|
|
755
774
|
loggingConfiguration?: LoggingConfiguration;
|
|
756
775
|
/**
|
|
757
|
-
* <p>Selects whether
|
|
776
|
+
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
758
777
|
*/
|
|
759
778
|
tracingConfiguration?: TracingConfiguration;
|
|
760
779
|
}
|
|
@@ -848,7 +867,7 @@ export interface ExecutionStartedEventDetails {
|
|
|
848
867
|
*/
|
|
849
868
|
inputDetails?: HistoryEventExecutionDataDetails;
|
|
850
869
|
/**
|
|
851
|
-
* <p>The Amazon Resource Name (ARN) of the IAM role used for executing
|
|
870
|
+
* <p>The Amazon Resource Name (ARN) of the IAM role used for executing Lambda tasks.</p>
|
|
852
871
|
*/
|
|
853
872
|
roleArn?: string;
|
|
854
873
|
}
|
|
@@ -879,7 +898,7 @@ export interface ExecutionTimedOutEventDetails {
|
|
|
879
898
|
cause?: string;
|
|
880
899
|
}
|
|
881
900
|
/**
|
|
882
|
-
* <p>Contains details about a
|
|
901
|
+
* <p>Contains details about a Lambda function that failed during an execution.</p>
|
|
883
902
|
*/
|
|
884
903
|
export interface LambdaFunctionFailedEventDetails {
|
|
885
904
|
/**
|
|
@@ -892,15 +911,24 @@ export interface LambdaFunctionFailedEventDetails {
|
|
|
892
911
|
cause?: string;
|
|
893
912
|
}
|
|
894
913
|
/**
|
|
895
|
-
* <p>Contains details about
|
|
914
|
+
* <p>Contains details about the credentials that Step Functions uses for a task.</p>
|
|
915
|
+
*/
|
|
916
|
+
export interface TaskCredentials {
|
|
917
|
+
/**
|
|
918
|
+
* <p>The ARN of an IAM role that Step Functions assumes for the task. The role can allow cross-account access to resources.</p>
|
|
919
|
+
*/
|
|
920
|
+
roleArn?: string;
|
|
921
|
+
}
|
|
922
|
+
/**
|
|
923
|
+
* <p>Contains details about a Lambda function scheduled during an execution.</p>
|
|
896
924
|
*/
|
|
897
925
|
export interface LambdaFunctionScheduledEventDetails {
|
|
898
926
|
/**
|
|
899
|
-
* <p>The Amazon Resource Name (ARN) of the scheduled
|
|
927
|
+
* <p>The Amazon Resource Name (ARN) of the scheduled Lambda function.</p>
|
|
900
928
|
*/
|
|
901
929
|
resource: string | undefined;
|
|
902
930
|
/**
|
|
903
|
-
* <p>The JSON data input to the
|
|
931
|
+
* <p>The JSON data input to the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
904
932
|
*/
|
|
905
933
|
input?: string;
|
|
906
934
|
/**
|
|
@@ -908,12 +936,16 @@ export interface LambdaFunctionScheduledEventDetails {
|
|
|
908
936
|
*/
|
|
909
937
|
inputDetails?: HistoryEventExecutionDataDetails;
|
|
910
938
|
/**
|
|
911
|
-
* <p>The maximum allowed duration of the
|
|
939
|
+
* <p>The maximum allowed duration of the Lambda function.</p>
|
|
912
940
|
*/
|
|
913
941
|
timeoutInSeconds?: number;
|
|
942
|
+
/**
|
|
943
|
+
* <p>The credentials that Step Functions uses for the task.</p>
|
|
944
|
+
*/
|
|
945
|
+
taskCredentials?: TaskCredentials;
|
|
914
946
|
}
|
|
915
947
|
/**
|
|
916
|
-
* <p>Contains details about a failed
|
|
948
|
+
* <p>Contains details about a failed Lambda function schedule event that occurred during an
|
|
917
949
|
* execution.</p>
|
|
918
950
|
*/
|
|
919
951
|
export interface LambdaFunctionScheduleFailedEventDetails {
|
|
@@ -940,12 +972,12 @@ export interface LambdaFunctionStartFailedEventDetails {
|
|
|
940
972
|
cause?: string;
|
|
941
973
|
}
|
|
942
974
|
/**
|
|
943
|
-
* <p>Contains details about a
|
|
975
|
+
* <p>Contains details about a Lambda function that successfully terminated during an
|
|
944
976
|
* execution.</p>
|
|
945
977
|
*/
|
|
946
978
|
export interface LambdaFunctionSucceededEventDetails {
|
|
947
979
|
/**
|
|
948
|
-
* <p>The JSON data output by the
|
|
980
|
+
* <p>The JSON data output by the Lambda function. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
949
981
|
*/
|
|
950
982
|
output?: string;
|
|
951
983
|
/**
|
|
@@ -954,7 +986,7 @@ export interface LambdaFunctionSucceededEventDetails {
|
|
|
954
986
|
outputDetails?: HistoryEventExecutionDataDetails;
|
|
955
987
|
}
|
|
956
988
|
/**
|
|
957
|
-
* <p>Contains details about a
|
|
989
|
+
* <p>Contains details about a Lambda function timeout that occurred during an execution.</p>
|
|
958
990
|
*/
|
|
959
991
|
export interface LambdaFunctionTimedOutEventDetails {
|
|
960
992
|
/**
|
|
@@ -1049,11 +1081,11 @@ export interface StateExitedEventDetails {
|
|
|
1049
1081
|
*/
|
|
1050
1082
|
export interface TaskFailedEventDetails {
|
|
1051
1083
|
/**
|
|
1052
|
-
* <p>The
|
|
1084
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1053
1085
|
*/
|
|
1054
1086
|
resourceType: string | undefined;
|
|
1055
1087
|
/**
|
|
1056
|
-
* <p>The
|
|
1088
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1057
1089
|
*/
|
|
1058
1090
|
resource: string | undefined;
|
|
1059
1091
|
/**
|
|
@@ -1070,11 +1102,11 @@ export interface TaskFailedEventDetails {
|
|
|
1070
1102
|
*/
|
|
1071
1103
|
export interface TaskScheduledEventDetails {
|
|
1072
1104
|
/**
|
|
1073
|
-
* <p>The
|
|
1105
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1074
1106
|
*/
|
|
1075
1107
|
resourceType: string | undefined;
|
|
1076
1108
|
/**
|
|
1077
|
-
* <p>The
|
|
1109
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1078
1110
|
*/
|
|
1079
1111
|
resource: string | undefined;
|
|
1080
1112
|
/**
|
|
@@ -1094,17 +1126,21 @@ export interface TaskScheduledEventDetails {
|
|
|
1094
1126
|
* <p>The maximum allowed duration between two heartbeats for the task.</p>
|
|
1095
1127
|
*/
|
|
1096
1128
|
heartbeatInSeconds?: number;
|
|
1129
|
+
/**
|
|
1130
|
+
* <p>The credentials that Step Functions uses for the task.</p>
|
|
1131
|
+
*/
|
|
1132
|
+
taskCredentials?: TaskCredentials;
|
|
1097
1133
|
}
|
|
1098
1134
|
/**
|
|
1099
1135
|
* <p>Contains details about the start of a task during an execution.</p>
|
|
1100
1136
|
*/
|
|
1101
1137
|
export interface TaskStartedEventDetails {
|
|
1102
1138
|
/**
|
|
1103
|
-
* <p>The
|
|
1139
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1104
1140
|
*/
|
|
1105
1141
|
resourceType: string | undefined;
|
|
1106
1142
|
/**
|
|
1107
|
-
* <p>The
|
|
1143
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1108
1144
|
*/
|
|
1109
1145
|
resource: string | undefined;
|
|
1110
1146
|
}
|
|
@@ -1113,11 +1149,11 @@ export interface TaskStartedEventDetails {
|
|
|
1113
1149
|
*/
|
|
1114
1150
|
export interface TaskStartFailedEventDetails {
|
|
1115
1151
|
/**
|
|
1116
|
-
* <p>The
|
|
1152
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1117
1153
|
*/
|
|
1118
1154
|
resourceType: string | undefined;
|
|
1119
1155
|
/**
|
|
1120
|
-
* <p>The
|
|
1156
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1121
1157
|
*/
|
|
1122
1158
|
resource: string | undefined;
|
|
1123
1159
|
/**
|
|
@@ -1134,11 +1170,11 @@ export interface TaskStartFailedEventDetails {
|
|
|
1134
1170
|
*/
|
|
1135
1171
|
export interface TaskSubmitFailedEventDetails {
|
|
1136
1172
|
/**
|
|
1137
|
-
* <p>The
|
|
1173
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1138
1174
|
*/
|
|
1139
1175
|
resourceType: string | undefined;
|
|
1140
1176
|
/**
|
|
1141
|
-
* <p>The
|
|
1177
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1142
1178
|
*/
|
|
1143
1179
|
resource: string | undefined;
|
|
1144
1180
|
/**
|
|
@@ -1155,11 +1191,11 @@ export interface TaskSubmitFailedEventDetails {
|
|
|
1155
1191
|
*/
|
|
1156
1192
|
export interface TaskSubmittedEventDetails {
|
|
1157
1193
|
/**
|
|
1158
|
-
* <p>The
|
|
1194
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1159
1195
|
*/
|
|
1160
1196
|
resourceType: string | undefined;
|
|
1161
1197
|
/**
|
|
1162
|
-
* <p>The
|
|
1198
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1163
1199
|
*/
|
|
1164
1200
|
resource: string | undefined;
|
|
1165
1201
|
/**
|
|
@@ -1176,11 +1212,11 @@ export interface TaskSubmittedEventDetails {
|
|
|
1176
1212
|
*/
|
|
1177
1213
|
export interface TaskSucceededEventDetails {
|
|
1178
1214
|
/**
|
|
1179
|
-
* <p>The
|
|
1215
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1180
1216
|
*/
|
|
1181
1217
|
resourceType: string | undefined;
|
|
1182
1218
|
/**
|
|
1183
|
-
* <p>The
|
|
1219
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1184
1220
|
*/
|
|
1185
1221
|
resource: string | undefined;
|
|
1186
1222
|
/**
|
|
@@ -1198,11 +1234,11 @@ export interface TaskSucceededEventDetails {
|
|
|
1198
1234
|
*/
|
|
1199
1235
|
export interface TaskTimedOutEventDetails {
|
|
1200
1236
|
/**
|
|
1201
|
-
* <p>The
|
|
1237
|
+
* <p>The service name of the resource in a task state.</p>
|
|
1202
1238
|
*/
|
|
1203
1239
|
resourceType: string | undefined;
|
|
1204
1240
|
/**
|
|
1205
|
-
* <p>The
|
|
1241
|
+
* <p>The action of the resource called by a task state.</p>
|
|
1206
1242
|
*/
|
|
1207
1243
|
resource: string | undefined;
|
|
1208
1244
|
/**
|
|
@@ -1214,7 +1250,63 @@ export interface TaskTimedOutEventDetails {
|
|
|
1214
1250
|
*/
|
|
1215
1251
|
cause?: string;
|
|
1216
1252
|
}
|
|
1217
|
-
export declare
|
|
1253
|
+
export declare enum HistoryEventType {
|
|
1254
|
+
ActivityFailed = "ActivityFailed",
|
|
1255
|
+
ActivityScheduleFailed = "ActivityScheduleFailed",
|
|
1256
|
+
ActivityScheduled = "ActivityScheduled",
|
|
1257
|
+
ActivityStarted = "ActivityStarted",
|
|
1258
|
+
ActivitySucceeded = "ActivitySucceeded",
|
|
1259
|
+
ActivityTimedOut = "ActivityTimedOut",
|
|
1260
|
+
ChoiceStateEntered = "ChoiceStateEntered",
|
|
1261
|
+
ChoiceStateExited = "ChoiceStateExited",
|
|
1262
|
+
ExecutionAborted = "ExecutionAborted",
|
|
1263
|
+
ExecutionFailed = "ExecutionFailed",
|
|
1264
|
+
ExecutionStarted = "ExecutionStarted",
|
|
1265
|
+
ExecutionSucceeded = "ExecutionSucceeded",
|
|
1266
|
+
ExecutionTimedOut = "ExecutionTimedOut",
|
|
1267
|
+
FailStateEntered = "FailStateEntered",
|
|
1268
|
+
LambdaFunctionFailed = "LambdaFunctionFailed",
|
|
1269
|
+
LambdaFunctionScheduleFailed = "LambdaFunctionScheduleFailed",
|
|
1270
|
+
LambdaFunctionScheduled = "LambdaFunctionScheduled",
|
|
1271
|
+
LambdaFunctionStartFailed = "LambdaFunctionStartFailed",
|
|
1272
|
+
LambdaFunctionStarted = "LambdaFunctionStarted",
|
|
1273
|
+
LambdaFunctionSucceeded = "LambdaFunctionSucceeded",
|
|
1274
|
+
LambdaFunctionTimedOut = "LambdaFunctionTimedOut",
|
|
1275
|
+
MapIterationAborted = "MapIterationAborted",
|
|
1276
|
+
MapIterationFailed = "MapIterationFailed",
|
|
1277
|
+
MapIterationStarted = "MapIterationStarted",
|
|
1278
|
+
MapIterationSucceeded = "MapIterationSucceeded",
|
|
1279
|
+
MapStateAborted = "MapStateAborted",
|
|
1280
|
+
MapStateEntered = "MapStateEntered",
|
|
1281
|
+
MapStateExited = "MapStateExited",
|
|
1282
|
+
MapStateFailed = "MapStateFailed",
|
|
1283
|
+
MapStateStarted = "MapStateStarted",
|
|
1284
|
+
MapStateSucceeded = "MapStateSucceeded",
|
|
1285
|
+
ParallelStateAborted = "ParallelStateAborted",
|
|
1286
|
+
ParallelStateEntered = "ParallelStateEntered",
|
|
1287
|
+
ParallelStateExited = "ParallelStateExited",
|
|
1288
|
+
ParallelStateFailed = "ParallelStateFailed",
|
|
1289
|
+
ParallelStateStarted = "ParallelStateStarted",
|
|
1290
|
+
ParallelStateSucceeded = "ParallelStateSucceeded",
|
|
1291
|
+
PassStateEntered = "PassStateEntered",
|
|
1292
|
+
PassStateExited = "PassStateExited",
|
|
1293
|
+
SucceedStateEntered = "SucceedStateEntered",
|
|
1294
|
+
SucceedStateExited = "SucceedStateExited",
|
|
1295
|
+
TaskFailed = "TaskFailed",
|
|
1296
|
+
TaskScheduled = "TaskScheduled",
|
|
1297
|
+
TaskStartFailed = "TaskStartFailed",
|
|
1298
|
+
TaskStarted = "TaskStarted",
|
|
1299
|
+
TaskStateAborted = "TaskStateAborted",
|
|
1300
|
+
TaskStateEntered = "TaskStateEntered",
|
|
1301
|
+
TaskStateExited = "TaskStateExited",
|
|
1302
|
+
TaskSubmitFailed = "TaskSubmitFailed",
|
|
1303
|
+
TaskSubmitted = "TaskSubmitted",
|
|
1304
|
+
TaskSucceeded = "TaskSucceeded",
|
|
1305
|
+
TaskTimedOut = "TaskTimedOut",
|
|
1306
|
+
WaitStateAborted = "WaitStateAborted",
|
|
1307
|
+
WaitStateEntered = "WaitStateEntered",
|
|
1308
|
+
WaitStateExited = "WaitStateExited"
|
|
1309
|
+
}
|
|
1218
1310
|
/**
|
|
1219
1311
|
* <p>Contains details about the events of an execution.</p>
|
|
1220
1312
|
*/
|
|
@@ -1333,16 +1425,16 @@ export interface HistoryEvent {
|
|
|
1333
1425
|
*/
|
|
1334
1426
|
mapIterationAbortedEventDetails?: MapIterationEventDetails;
|
|
1335
1427
|
/**
|
|
1336
|
-
* <p>Contains details about a
|
|
1428
|
+
* <p>Contains details about a Lambda function that failed during an execution.</p>
|
|
1337
1429
|
*/
|
|
1338
1430
|
lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails;
|
|
1339
1431
|
/**
|
|
1340
|
-
* <p>Contains details about a failed
|
|
1432
|
+
* <p>Contains details about a failed Lambda function schedule event that occurred during an
|
|
1341
1433
|
* execution.</p>
|
|
1342
1434
|
*/
|
|
1343
1435
|
lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails;
|
|
1344
1436
|
/**
|
|
1345
|
-
* <p>Contains details about a
|
|
1437
|
+
* <p>Contains details about a Lambda function scheduled during an execution.</p>
|
|
1346
1438
|
*/
|
|
1347
1439
|
lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails;
|
|
1348
1440
|
/**
|
|
@@ -1350,12 +1442,12 @@ export interface HistoryEvent {
|
|
|
1350
1442
|
*/
|
|
1351
1443
|
lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails;
|
|
1352
1444
|
/**
|
|
1353
|
-
* <p>Contains details about a
|
|
1445
|
+
* <p>Contains details about a Lambda function that terminated successfully during an
|
|
1354
1446
|
* execution.</p>
|
|
1355
1447
|
*/
|
|
1356
1448
|
lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails;
|
|
1357
1449
|
/**
|
|
1358
|
-
* <p>Contains details about a
|
|
1450
|
+
* <p>Contains details about a Lambda function timeout that occurred during an execution.</p>
|
|
1359
1451
|
*/
|
|
1360
1452
|
lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails;
|
|
1361
1453
|
/**
|
|
@@ -1700,9 +1792,9 @@ export interface StartExecutionInput {
|
|
|
1700
1792
|
*/
|
|
1701
1793
|
stateMachineArn: string | undefined;
|
|
1702
1794
|
/**
|
|
1703
|
-
* <p>The name of the execution. This name must be unique for your
|
|
1795
|
+
* <p>The name of the execution. This name must be unique for your Amazon Web Services account, region, and state machine for 90 days. For more information,
|
|
1704
1796
|
* see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
|
|
1705
|
-
* Limits Related to State Machine Executions</a> in the <i>
|
|
1797
|
+
* Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p>
|
|
1706
1798
|
* <p>A name must <i>not</i> contain:</p>
|
|
1707
1799
|
* <ul>
|
|
1708
1800
|
* <li>
|
|
@@ -1741,7 +1833,8 @@ export interface StartExecutionInput {
|
|
|
1741
1833
|
*/
|
|
1742
1834
|
input?: string;
|
|
1743
1835
|
/**
|
|
1744
|
-
* <p>Passes the
|
|
1836
|
+
* <p>Passes the X-Ray trace header. The trace header can also be passed in the request
|
|
1837
|
+
* payload.</p>
|
|
1745
1838
|
*/
|
|
1746
1839
|
traceHeader?: string;
|
|
1747
1840
|
}
|
|
@@ -1771,14 +1864,15 @@ export interface StartSyncExecutionInput {
|
|
|
1771
1864
|
* </p>
|
|
1772
1865
|
* <note>
|
|
1773
1866
|
* <p>If you don't include any JSON input data, you still must include the two braces, for
|
|
1774
|
-
*
|
|
1867
|
+
* example: <code>"input": "{}"</code>
|
|
1775
1868
|
* </p>
|
|
1776
1869
|
* </note>
|
|
1777
1870
|
* <p>Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
1778
1871
|
*/
|
|
1779
1872
|
input?: string;
|
|
1780
1873
|
/**
|
|
1781
|
-
* <p>Passes the
|
|
1874
|
+
* <p>Passes the X-Ray trace header. The trace header can also be passed in the request
|
|
1875
|
+
* payload.</p>
|
|
1782
1876
|
*/
|
|
1783
1877
|
traceHeader?: string;
|
|
1784
1878
|
}
|
|
@@ -1795,7 +1889,11 @@ export interface BillingDetails {
|
|
|
1795
1889
|
*/
|
|
1796
1890
|
billedDurationInMilliseconds?: number;
|
|
1797
1891
|
}
|
|
1798
|
-
export declare
|
|
1892
|
+
export declare enum SyncExecutionStatus {
|
|
1893
|
+
FAILED = "FAILED",
|
|
1894
|
+
SUCCEEDED = "SUCCEEDED",
|
|
1895
|
+
TIMED_OUT = "TIMED_OUT"
|
|
1896
|
+
}
|
|
1799
1897
|
export interface StartSyncExecutionOutput {
|
|
1800
1898
|
/**
|
|
1801
1899
|
* <p>The Amazon Resource Name (ARN) that identifies the execution.</p>
|
|
@@ -1841,7 +1939,7 @@ export interface StartSyncExecutionOutput {
|
|
|
1841
1939
|
* <p>The JSON output data of the execution. Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.</p>
|
|
1842
1940
|
* <note>
|
|
1843
1941
|
* <p>This field is set only if the execution succeeds. If the execution fails, this field is
|
|
1844
|
-
*
|
|
1942
|
+
* null.</p>
|
|
1845
1943
|
* </note>
|
|
1846
1944
|
*/
|
|
1847
1945
|
output?: string;
|
|
@@ -1850,12 +1948,12 @@ export interface StartSyncExecutionOutput {
|
|
|
1850
1948
|
*/
|
|
1851
1949
|
outputDetails?: CloudWatchEventsExecutionDataDetails;
|
|
1852
1950
|
/**
|
|
1853
|
-
* <p>The
|
|
1951
|
+
* <p>The X-Ray trace header that was passed to the execution.</p>
|
|
1854
1952
|
*/
|
|
1855
1953
|
traceHeader?: string;
|
|
1856
1954
|
/**
|
|
1857
|
-
* <p>An object that describes workflow billing details, including billed duration
|
|
1858
|
-
*
|
|
1955
|
+
* <p>An object that describes workflow billing details, including billed duration and memory
|
|
1956
|
+
* use.</p>
|
|
1859
1957
|
*/
|
|
1860
1958
|
billingDetails?: BillingDetails;
|
|
1861
1959
|
}
|
|
@@ -1935,7 +2033,7 @@ export interface UpdateStateMachineInput {
|
|
|
1935
2033
|
*/
|
|
1936
2034
|
loggingConfiguration?: LoggingConfiguration;
|
|
1937
2035
|
/**
|
|
1938
|
-
* <p>Selects whether
|
|
2036
|
+
* <p>Selects whether X-Ray tracing is enabled.</p>
|
|
1939
2037
|
*/
|
|
1940
2038
|
tracingConfiguration?: TracingConfiguration;
|
|
1941
2039
|
}
|
|
@@ -2101,6 +2199,10 @@ export declare const ExecutionTimedOutEventDetailsFilterSensitiveLog: (obj: Exec
|
|
|
2101
2199
|
* @internal
|
|
2102
2200
|
*/
|
|
2103
2201
|
export declare const LambdaFunctionFailedEventDetailsFilterSensitiveLog: (obj: LambdaFunctionFailedEventDetails) => any;
|
|
2202
|
+
/**
|
|
2203
|
+
* @internal
|
|
2204
|
+
*/
|
|
2205
|
+
export declare const TaskCredentialsFilterSensitiveLog: (obj: TaskCredentials) => any;
|
|
2104
2206
|
/**
|
|
2105
2207
|
* @internal
|
|
2106
2208
|
*/
|