UNPKG

62.1 kBTypeScriptView Raw
1import {Request} from '../lib/request';
2import {Response} from '../lib/response';
3import {AWSError} from '../lib/error';
4import {Service} from '../lib/service';
5import {ServiceConfigurationOptions} from '../lib/service';
6import {ConfigBase as Config} from '../lib/config';
7interface Blob {}
8declare class StepFunctions extends Service {
9 /**
10 * Constructs a service object. This object has one method for each API operation.
11 */
12 constructor(options?: StepFunctions.Types.ClientConfiguration)
13 config: Config & StepFunctions.Types.ClientConfiguration;
14 /**
15 * Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
16 */
17 createActivity(params: StepFunctions.Types.CreateActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request<StepFunctions.Types.CreateActivityOutput, AWSError>;
18 /**
19 * Creates an activity. An activity is a task that you write in any programming language and host on any machine that has access to AWS Step Functions. Activities must poll Step Functions using the GetActivityTask API action and respond using SendTask* API actions. This function lets Step Functions know the existence of your activity and returns an identifier for use in a state machine and when polling from the activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateActivity is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateActivity's idempotency check is based on the activity name. If a following request has different tags values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, tags will not be updated, even if they are different.
20 */
21 createActivity(callback?: (err: AWSError, data: StepFunctions.Types.CreateActivityOutput) => void): Request<StepFunctions.Types.CreateActivityOutput, AWSError>;
22 /**
23 * Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name and definition. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
24 */
25 createStateMachine(params: StepFunctions.Types.CreateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>;
26 /**
27 * Creates a state machine. A state machine consists of a collection of states that can do work (Task states), determine to which states to transition next (Choice states), stop an execution with an error (Fail states), and so on. State machines are specified using a JSON-based, structured language. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes. CreateStateMachine is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. CreateStateMachine's idempotency check is based on the state machine name and definition. If a following request has a different roleArn or tags, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, roleArn and tags will not be updated, even if they are different.
28 */
29 createStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.CreateStateMachineOutput) => void): Request<StepFunctions.Types.CreateStateMachineOutput, AWSError>;
30 /**
31 * Deletes an activity.
32 */
33 deleteActivity(params: StepFunctions.Types.DeleteActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request<StepFunctions.Types.DeleteActivityOutput, AWSError>;
34 /**
35 * Deletes an activity.
36 */
37 deleteActivity(callback?: (err: AWSError, data: StepFunctions.Types.DeleteActivityOutput) => void): Request<StepFunctions.Types.DeleteActivityOutput, AWSError>;
38 /**
39 * Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted.
40 */
41 deleteStateMachine(params: StepFunctions.Types.DeleteStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>;
42 /**
43 * Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition. The state machine itself is deleted after all executions are completed or deleted.
44 */
45 deleteStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DeleteStateMachineOutput) => void): Request<StepFunctions.Types.DeleteStateMachineOutput, AWSError>;
46 /**
47 * Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
48 */
49 describeActivity(params: StepFunctions.Types.DescribeActivityInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request<StepFunctions.Types.DescribeActivityOutput, AWSError>;
50 /**
51 * Describes an activity. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
52 */
53 describeActivity(callback?: (err: AWSError, data: StepFunctions.Types.DescribeActivityOutput) => void): Request<StepFunctions.Types.DescribeActivityOutput, AWSError>;
54 /**
55 * Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
56 */
57 describeExecution(params: StepFunctions.Types.DescribeExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>;
58 /**
59 * Describes an execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
60 */
61 describeExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeExecutionOutput) => void): Request<StepFunctions.Types.DescribeExecutionOutput, AWSError>;
62 /**
63 * Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
64 */
65 describeStateMachine(params: StepFunctions.Types.DescribeStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>;
66 /**
67 * Describes a state machine. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
68 */
69 describeStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineOutput) => void): Request<StepFunctions.Types.DescribeStateMachineOutput, AWSError>;
70 /**
71 * Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
72 */
73 describeStateMachineForExecution(params: StepFunctions.Types.DescribeStateMachineForExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>;
74 /**
75 * Describes the state machine associated with a specific execution. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
76 */
77 describeStateMachineForExecution(callback?: (err: AWSError, data: StepFunctions.Types.DescribeStateMachineForExecutionOutput) => void): Request<StepFunctions.Types.DescribeStateMachineForExecutionOutput, AWSError>;
78 /**
79 * Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
80 */
81 getActivityTask(params: StepFunctions.Types.GetActivityTaskInput, callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request<StepFunctions.Types.GetActivityTaskOutput, AWSError>;
82 /**
83 * Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine. This initiates a long poll, where the service holds the HTTP connection open and responds as soon as a task becomes available (i.e. an execution of a task of this type is needed.) The maximum time the service holds on to the request before responding is 60 seconds. If no task is available within 60 seconds, the poll returns a taskToken with a null string. Workers should set their client side socket timeout to at least 65 seconds (5 seconds higher than the maximum time the service may hold the poll request). Polling with GetActivityTask can cause latency in some implementations. See Avoid Latency When Polling for Activity Tasks in the Step Functions Developer Guide.
84 */
85 getActivityTask(callback?: (err: AWSError, data: StepFunctions.Types.GetActivityTaskOutput) => void): Request<StepFunctions.Types.GetActivityTaskOutput, AWSError>;
86 /**
87 * Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
88 */
89 getExecutionHistory(params: StepFunctions.Types.GetExecutionHistoryInput, callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request<StepFunctions.Types.GetExecutionHistoryOutput, AWSError>;
90 /**
91 * Returns the history of the specified execution as a list of events. By default, the results are returned in ascending order of the timeStamp of the events. Use the reverseOrder parameter to get the latest events first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
92 */
93 getExecutionHistory(callback?: (err: AWSError, data: StepFunctions.Types.GetExecutionHistoryOutput) => void): Request<StepFunctions.Types.GetExecutionHistoryOutput, AWSError>;
94 /**
95 * Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
96 */
97 listActivities(params: StepFunctions.Types.ListActivitiesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request<StepFunctions.Types.ListActivitiesOutput, AWSError>;
98 /**
99 * Lists the existing activities. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
100 */
101 listActivities(callback?: (err: AWSError, data: StepFunctions.Types.ListActivitiesOutput) => void): Request<StepFunctions.Types.ListActivitiesOutput, AWSError>;
102 /**
103 * Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
104 */
105 listExecutions(params: StepFunctions.Types.ListExecutionsInput, callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>;
106 /**
107 * Lists the executions of a state machine that meet the filtering criteria. Results are sorted by time, with the most recent execution first. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
108 */
109 listExecutions(callback?: (err: AWSError, data: StepFunctions.Types.ListExecutionsOutput) => void): Request<StepFunctions.Types.ListExecutionsOutput, AWSError>;
110 /**
111 * Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
112 */
113 listStateMachines(params: StepFunctions.Types.ListStateMachinesInput, callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request<StepFunctions.Types.ListStateMachinesOutput, AWSError>;
114 /**
115 * Lists the existing state machines. If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
116 */
117 listStateMachines(callback?: (err: AWSError, data: StepFunctions.Types.ListStateMachinesOutput) => void): Request<StepFunctions.Types.ListStateMachinesOutput, AWSError>;
118 /**
119 * List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
120 */
121 listTagsForResource(params: StepFunctions.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request<StepFunctions.Types.ListTagsForResourceOutput, AWSError>;
122 /**
123 * List tags for a given resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
124 */
125 listTagsForResource(callback?: (err: AWSError, data: StepFunctions.Types.ListTagsForResourceOutput) => void): Request<StepFunctions.Types.ListTagsForResourceOutput, AWSError>;
126 /**
127 * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
128 */
129 sendTaskFailure(params: StepFunctions.Types.SendTaskFailureInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request<StepFunctions.Types.SendTaskFailureOutput, AWSError>;
130 /**
131 * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.
132 */
133 sendTaskFailure(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskFailureOutput) => void): Request<StepFunctions.Types.SendTaskFailureOutput, AWSError>;
134 /**
135 * Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
136 */
137 sendTaskHeartbeat(params: StepFunctions.Types.SendTaskHeartbeatInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request<StepFunctions.Types.SendTaskHeartbeatOutput, AWSError>;
138 /**
139 * Used by activity workers and task states using the callback pattern to report to Step Functions that the task represented by the specified taskToken is still making progress. This action resets the Heartbeat clock. The Heartbeat threshold is specified in the state machine's Amazon States Language definition (HeartbeatSeconds). This action does not in itself create an event in the execution history. However, if the task times out, the execution history contains an ActivityTimedOut entry for activities, or a TaskTimedOut entry for for tasks using the job run or callback pattern. The Timeout of a task, defined in the state machine's Amazon States Language definition, is its maximum allowed duration, regardless of the number of SendTaskHeartbeat requests received. Use HeartbeatSeconds to configure the timeout interval for heartbeats.
140 */
141 sendTaskHeartbeat(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskHeartbeatOutput) => void): Request<StepFunctions.Types.SendTaskHeartbeatOutput, AWSError>;
142 /**
143 * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
144 */
145 sendTaskSuccess(params: StepFunctions.Types.SendTaskSuccessInput, callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request<StepFunctions.Types.SendTaskSuccessOutput, AWSError>;
146 /**
147 * Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.
148 */
149 sendTaskSuccess(callback?: (err: AWSError, data: StepFunctions.Types.SendTaskSuccessOutput) => void): Request<StepFunctions.Types.SendTaskSuccessOutput, AWSError>;
150 /**
151 * Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
152 */
153 startExecution(params: StepFunctions.Types.StartExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>;
154 /**
155 * Starts a state machine execution. StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.
156 */
157 startExecution(callback?: (err: AWSError, data: StepFunctions.Types.StartExecutionOutput) => void): Request<StepFunctions.Types.StartExecutionOutput, AWSError>;
158 /**
159 * Stops an execution.
160 */
161 stopExecution(params: StepFunctions.Types.StopExecutionInput, callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request<StepFunctions.Types.StopExecutionOutput, AWSError>;
162 /**
163 * Stops an execution.
164 */
165 stopExecution(callback?: (err: AWSError, data: StepFunctions.Types.StopExecutionOutput) => void): Request<StepFunctions.Types.StopExecutionOutput, AWSError>;
166 /**
167 * Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
168 */
169 tagResource(params: StepFunctions.Types.TagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request<StepFunctions.Types.TagResourceOutput, AWSError>;
170 /**
171 * Add a tag to a Step Functions resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
172 */
173 tagResource(callback?: (err: AWSError, data: StepFunctions.Types.TagResourceOutput) => void): Request<StepFunctions.Types.TagResourceOutput, AWSError>;
174 /**
175 * Remove a tag from a Step Functions resource
176 */
177 untagResource(params: StepFunctions.Types.UntagResourceInput, callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request<StepFunctions.Types.UntagResourceOutput, AWSError>;
178 /**
179 * Remove a tag from a Step Functions resource
180 */
181 untagResource(callback?: (err: AWSError, data: StepFunctions.Types.UntagResourceOutput) => void): Request<StepFunctions.Types.UntagResourceOutput, AWSError>;
182 /**
183 * Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
184 */
185 updateStateMachine(params: StepFunctions.Types.UpdateStateMachineInput, callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>;
186 /**
187 * Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error. All StartExecution calls within a few seconds will use the updated definition and roleArn. Executions started immediately after calling UpdateStateMachine may use the previous state machine definition and roleArn.
188 */
189 updateStateMachine(callback?: (err: AWSError, data: StepFunctions.Types.UpdateStateMachineOutput) => void): Request<StepFunctions.Types.UpdateStateMachineOutput, AWSError>;
190}
191declare namespace StepFunctions {
192 export interface ActivityFailedEventDetails {
193 /**
194 * The error code of the failure.
195 */
196 error?: SensitiveError;
197 /**
198 * A more detailed explanation of the cause of the failure.
199 */
200 cause?: SensitiveCause;
201 }
202 export type ActivityList = ActivityListItem[];
203 export interface ActivityListItem {
204 /**
205 * The Amazon Resource Name (ARN) that identifies the activity.
206 */
207 activityArn: Arn;
208 /**
209 * The name of the activity. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
210 */
211 name: Name;
212 /**
213 * The date the activity is created.
214 */
215 creationDate: Timestamp;
216 }
217 export interface ActivityScheduleFailedEventDetails {
218 /**
219 * The error code of the failure.
220 */
221 error?: SensitiveError;
222 /**
223 * A more detailed explanation of the cause of the failure.
224 */
225 cause?: SensitiveCause;
226 }
227 export interface ActivityScheduledEventDetails {
228 /**
229 * The Amazon Resource Name (ARN) of the scheduled activity.
230 */
231 resource: Arn;
232 /**
233 * The JSON data input to the activity task.
234 */
235 input?: SensitiveData;
236 /**
237 * The maximum allowed duration of the activity task.
238 */
239 timeoutInSeconds?: TimeoutInSeconds;
240 /**
241 * The maximum allowed duration between two heartbeats for the activity task.
242 */
243 heartbeatInSeconds?: TimeoutInSeconds;
244 }
245 export interface ActivityStartedEventDetails {
246 /**
247 * The name of the worker that the task is assigned to. These names are provided by the workers when calling GetActivityTask.
248 */
249 workerName?: Identity;
250 }
251 export interface ActivitySucceededEventDetails {
252 /**
253 * The JSON data output by the activity task.
254 */
255 output?: SensitiveData;
256 }
257 export interface ActivityTimedOutEventDetails {
258 /**
259 * The error code of the failure.
260 */
261 error?: SensitiveError;
262 /**
263 * A more detailed explanation of the cause of the timeout.
264 */
265 cause?: SensitiveCause;
266 }
267 export type Arn = string;
268 export type ConnectorParameters = string;
269 export interface CreateActivityInput {
270 /**
271 * The name of the activity to create. This name must be unique for your AWS account and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
272 */
273 name: Name;
274 /**
275 * The list of tags to add to a resource. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
276 */
277 tags?: TagList;
278 }
279 export interface CreateActivityOutput {
280 /**
281 * The Amazon Resource Name (ARN) that identifies the created activity.
282 */
283 activityArn: Arn;
284 /**
285 * The date the activity is created.
286 */
287 creationDate: Timestamp;
288 }
289 export interface CreateStateMachineInput {
290 /**
291 * The name of the state machine. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
292 */
293 name: Name;
294 /**
295 * The Amazon States Language definition of the state machine. See Amazon States Language.
296 */
297 definition: Definition;
298 /**
299 * The Amazon Resource Name (ARN) of the IAM role to use for this state machine.
300 */
301 roleArn: Arn;
302 /**
303 * Tags to be added when creating a state machine. An array of key-value pairs. For more information, see Using Cost Allocation Tags in the AWS Billing and Cost Management User Guide, and Controlling Access Using IAM Tags. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
304 */
305 tags?: TagList;
306 }
307 export interface CreateStateMachineOutput {
308 /**
309 * The Amazon Resource Name (ARN) that identifies the created state machine.
310 */
311 stateMachineArn: Arn;
312 /**
313 * The date the state machine is created.
314 */
315 creationDate: Timestamp;
316 }
317 export type Definition = string;
318 export interface DeleteActivityInput {
319 /**
320 * The Amazon Resource Name (ARN) of the activity to delete.
321 */
322 activityArn: Arn;
323 }
324 export interface DeleteActivityOutput {
325 }
326 export interface DeleteStateMachineInput {
327 /**
328 * The Amazon Resource Name (ARN) of the state machine to delete.
329 */
330 stateMachineArn: Arn;
331 }
332 export interface DeleteStateMachineOutput {
333 }
334 export interface DescribeActivityInput {
335 /**
336 * The Amazon Resource Name (ARN) of the activity to describe.
337 */
338 activityArn: Arn;
339 }
340 export interface DescribeActivityOutput {
341 /**
342 * The Amazon Resource Name (ARN) that identifies the activity.
343 */
344 activityArn: Arn;
345 /**
346 * The name of the activity. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
347 */
348 name: Name;
349 /**
350 * The date the activity is created.
351 */
352 creationDate: Timestamp;
353 }
354 export interface DescribeExecutionInput {
355 /**
356 * The Amazon Resource Name (ARN) of the execution to describe.
357 */
358 executionArn: Arn;
359 }
360 export interface DescribeExecutionOutput {
361 /**
362 * The Amazon Resource Name (ARN) that identifies the execution.
363 */
364 executionArn: Arn;
365 /**
366 * The Amazon Resource Name (ARN) of the executed stated machine.
367 */
368 stateMachineArn: Arn;
369 /**
370 * The name of the execution. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
371 */
372 name?: Name;
373 /**
374 * The current status of the execution.
375 */
376 status: ExecutionStatus;
377 /**
378 * The date the execution is started.
379 */
380 startDate: Timestamp;
381 /**
382 * If the execution has already ended, the date the execution stopped.
383 */
384 stopDate?: Timestamp;
385 /**
386 * The string that contains the JSON input data of the execution.
387 */
388 input: SensitiveData;
389 /**
390 * The JSON output data of the execution. This field is set only if the execution succeeds. If the execution fails, this field is null.
391 */
392 output?: SensitiveData;
393 }
394 export interface DescribeStateMachineForExecutionInput {
395 /**
396 * The Amazon Resource Name (ARN) of the execution you want state machine information for.
397 */
398 executionArn: Arn;
399 }
400 export interface DescribeStateMachineForExecutionOutput {
401 /**
402 * The Amazon Resource Name (ARN) of the state machine associated with the execution.
403 */
404 stateMachineArn: Arn;
405 /**
406 * The name of the state machine associated with the execution.
407 */
408 name: Name;
409 /**
410 * The Amazon States Language definition of the state machine. See Amazon States Language.
411 */
412 definition: Definition;
413 /**
414 * The Amazon Resource Name (ARN) of the IAM role of the State Machine for the execution.
415 */
416 roleArn: Arn;
417 /**
418 * The date and time the state machine associated with an execution was updated. For a newly created state machine, this is the creation date.
419 */
420 updateDate: Timestamp;
421 }
422 export interface DescribeStateMachineInput {
423 /**
424 * The Amazon Resource Name (ARN) of the state machine to describe.
425 */
426 stateMachineArn: Arn;
427 }
428 export interface DescribeStateMachineOutput {
429 /**
430 * The Amazon Resource Name (ARN) that identifies the state machine.
431 */
432 stateMachineArn: Arn;
433 /**
434 * The name of the state machine. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
435 */
436 name: Name;
437 /**
438 * The current status of the state machine.
439 */
440 status?: StateMachineStatus;
441 /**
442 * The Amazon States Language definition of the state machine. See Amazon States Language.
443 */
444 definition: Definition;
445 /**
446 * The Amazon Resource Name (ARN) of the IAM role used when creating this state machine. (The IAM role maintains security by granting Step Functions access to AWS resources.)
447 */
448 roleArn: Arn;
449 /**
450 * The date the state machine is created.
451 */
452 creationDate: Timestamp;
453 }
454 export type EventId = number;
455 export interface ExecutionAbortedEventDetails {
456 /**
457 * The error code of the failure.
458 */
459 error?: SensitiveError;
460 /**
461 * A more detailed explanation of the cause of the failure.
462 */
463 cause?: SensitiveCause;
464 }
465 export interface ExecutionFailedEventDetails {
466 /**
467 * The error code of the failure.
468 */
469 error?: SensitiveError;
470 /**
471 * A more detailed explanation of the cause of the failure.
472 */
473 cause?: SensitiveCause;
474 }
475 export type ExecutionList = ExecutionListItem[];
476 export interface ExecutionListItem {
477 /**
478 * The Amazon Resource Name (ARN) that identifies the execution.
479 */
480 executionArn: Arn;
481 /**
482 * The Amazon Resource Name (ARN) of the executed state machine.
483 */
484 stateMachineArn: Arn;
485 /**
486 * The name of the execution. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
487 */
488 name: Name;
489 /**
490 * The current status of the execution.
491 */
492 status: ExecutionStatus;
493 /**
494 * The date the execution started.
495 */
496 startDate: Timestamp;
497 /**
498 * If the execution already ended, the date the execution stopped.
499 */
500 stopDate?: Timestamp;
501 }
502 export interface ExecutionStartedEventDetails {
503 /**
504 * The JSON data input to the execution.
505 */
506 input?: SensitiveData;
507 /**
508 * The Amazon Resource Name (ARN) of the IAM role used for executing AWS Lambda tasks.
509 */
510 roleArn?: Arn;
511 }
512 export type ExecutionStatus = "RUNNING"|"SUCCEEDED"|"FAILED"|"TIMED_OUT"|"ABORTED"|string;
513 export interface ExecutionSucceededEventDetails {
514 /**
515 * The JSON data output by the execution.
516 */
517 output?: SensitiveData;
518 }
519 export interface ExecutionTimedOutEventDetails {
520 /**
521 * The error code of the failure.
522 */
523 error?: SensitiveError;
524 /**
525 * A more detailed explanation of the cause of the timeout.
526 */
527 cause?: SensitiveCause;
528 }
529 export interface GetActivityTaskInput {
530 /**
531 * The Amazon Resource Name (ARN) of the activity to retrieve tasks from (assigned when you create the task using CreateActivity.)
532 */
533 activityArn: Arn;
534 /**
535 * You can provide an arbitrary name in order to identify the worker that the task is assigned to. This name is used when it is logged in the execution history.
536 */
537 workerName?: Name;
538 }
539 export interface GetActivityTaskOutput {
540 /**
541 * A token that identifies the scheduled task. This token must be copied and included in subsequent calls to SendTaskHeartbeat, SendTaskSuccess or SendTaskFailure in order to report the progress or completion of the task.
542 */
543 taskToken?: TaskToken;
544 /**
545 * The string that contains the JSON input data for the task.
546 */
547 input?: SensitiveDataJobInput;
548 }
549 export interface GetExecutionHistoryInput {
550 /**
551 * The Amazon Resource Name (ARN) of the execution.
552 */
553 executionArn: Arn;
554 /**
555 * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
556 */
557 maxResults?: PageSize;
558 /**
559 * Lists events in descending order of their timeStamp.
560 */
561 reverseOrder?: ReverseOrder;
562 /**
563 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
564 */
565 nextToken?: PageToken;
566 }
567 export interface GetExecutionHistoryOutput {
568 /**
569 * The list of events that occurred in the execution.
570 */
571 events: HistoryEventList;
572 /**
573 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
574 */
575 nextToken?: PageToken;
576 }
577 export interface HistoryEvent {
578 /**
579 * The date and time the event occurred.
580 */
581 timestamp: Timestamp;
582 /**
583 * The type of the event.
584 */
585 type: HistoryEventType;
586 /**
587 * The id of the event. Events are numbered sequentially, starting at one.
588 */
589 id: EventId;
590 /**
591 * The id of the previous event.
592 */
593 previousEventId?: EventId;
594 activityFailedEventDetails?: ActivityFailedEventDetails;
595 /**
596 * Contains details about an activity schedule event that failed during an execution.
597 */
598 activityScheduleFailedEventDetails?: ActivityScheduleFailedEventDetails;
599 activityScheduledEventDetails?: ActivityScheduledEventDetails;
600 activityStartedEventDetails?: ActivityStartedEventDetails;
601 activitySucceededEventDetails?: ActivitySucceededEventDetails;
602 activityTimedOutEventDetails?: ActivityTimedOutEventDetails;
603 /**
604 * Contains details about the failure of a task.
605 */
606 taskFailedEventDetails?: TaskFailedEventDetails;
607 /**
608 * Contains details about a task that was scheduled.
609 */
610 taskScheduledEventDetails?: TaskScheduledEventDetails;
611 /**
612 * Contains details about a task that failed to start.
613 */
614 taskStartFailedEventDetails?: TaskStartFailedEventDetails;
615 /**
616 * Contains details about a task that was started.
617 */
618 taskStartedEventDetails?: TaskStartedEventDetails;
619 /**
620 * Contains details about a task that where the submit failed.
621 */
622 taskSubmitFailedEventDetails?: TaskSubmitFailedEventDetails;
623 /**
624 * Contains details about a submitted task.
625 */
626 taskSubmittedEventDetails?: TaskSubmittedEventDetails;
627 /**
628 * Contains details about a task that succeeded.
629 */
630 taskSucceededEventDetails?: TaskSucceededEventDetails;
631 /**
632 * Contains details about a task that timed out.
633 */
634 taskTimedOutEventDetails?: TaskTimedOutEventDetails;
635 executionFailedEventDetails?: ExecutionFailedEventDetails;
636 executionStartedEventDetails?: ExecutionStartedEventDetails;
637 executionSucceededEventDetails?: ExecutionSucceededEventDetails;
638 executionAbortedEventDetails?: ExecutionAbortedEventDetails;
639 executionTimedOutEventDetails?: ExecutionTimedOutEventDetails;
640 /**
641 * Contains details about Map state that was started.
642 */
643 mapStateStartedEventDetails?: MapStateStartedEventDetails;
644 /**
645 * Contains details about an iteration of a Map state that was started.
646 */
647 mapIterationStartedEventDetails?: MapIterationEventDetails;
648 /**
649 * Contains details about an iteration of a Map state that succeeded.
650 */
651 mapIterationSucceededEventDetails?: MapIterationEventDetails;
652 /**
653 * Contains details about an iteration of a Map state that failed.
654 */
655 mapIterationFailedEventDetails?: MapIterationEventDetails;
656 /**
657 * Contains details about an iteration of a Map state that was aborted.
658 */
659 mapIterationAbortedEventDetails?: MapIterationEventDetails;
660 lambdaFunctionFailedEventDetails?: LambdaFunctionFailedEventDetails;
661 lambdaFunctionScheduleFailedEventDetails?: LambdaFunctionScheduleFailedEventDetails;
662 lambdaFunctionScheduledEventDetails?: LambdaFunctionScheduledEventDetails;
663 /**
664 * Contains details about a lambda function that failed to start during an execution.
665 */
666 lambdaFunctionStartFailedEventDetails?: LambdaFunctionStartFailedEventDetails;
667 /**
668 * Contains details about a lambda function that terminated successfully during an execution.
669 */
670 lambdaFunctionSucceededEventDetails?: LambdaFunctionSucceededEventDetails;
671 lambdaFunctionTimedOutEventDetails?: LambdaFunctionTimedOutEventDetails;
672 stateEnteredEventDetails?: StateEnteredEventDetails;
673 stateExitedEventDetails?: StateExitedEventDetails;
674 }
675 export type HistoryEventList = HistoryEvent[];
676 export type HistoryEventType = "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"|string;
677 export type Identity = string;
678 export interface LambdaFunctionFailedEventDetails {
679 /**
680 * The error code of the failure.
681 */
682 error?: SensitiveError;
683 /**
684 * A more detailed explanation of the cause of the failure.
685 */
686 cause?: SensitiveCause;
687 }
688 export interface LambdaFunctionScheduleFailedEventDetails {
689 /**
690 * The error code of the failure.
691 */
692 error?: SensitiveError;
693 /**
694 * A more detailed explanation of the cause of the failure.
695 */
696 cause?: SensitiveCause;
697 }
698 export interface LambdaFunctionScheduledEventDetails {
699 /**
700 * The Amazon Resource Name (ARN) of the scheduled lambda function.
701 */
702 resource: Arn;
703 /**
704 * The JSON data input to the lambda function.
705 */
706 input?: SensitiveData;
707 /**
708 * The maximum allowed duration of the lambda function.
709 */
710 timeoutInSeconds?: TimeoutInSeconds;
711 }
712 export interface LambdaFunctionStartFailedEventDetails {
713 /**
714 * The error code of the failure.
715 */
716 error?: SensitiveError;
717 /**
718 * A more detailed explanation of the cause of the failure.
719 */
720 cause?: SensitiveCause;
721 }
722 export interface LambdaFunctionSucceededEventDetails {
723 /**
724 * The JSON data output by the lambda function.
725 */
726 output?: SensitiveData;
727 }
728 export interface LambdaFunctionTimedOutEventDetails {
729 /**
730 * The error code of the failure.
731 */
732 error?: SensitiveError;
733 /**
734 * A more detailed explanation of the cause of the timeout.
735 */
736 cause?: SensitiveCause;
737 }
738 export interface ListActivitiesInput {
739 /**
740 * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
741 */
742 maxResults?: PageSize;
743 /**
744 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
745 */
746 nextToken?: PageToken;
747 }
748 export interface ListActivitiesOutput {
749 /**
750 * The list of activities.
751 */
752 activities: ActivityList;
753 /**
754 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
755 */
756 nextToken?: PageToken;
757 }
758 export interface ListExecutionsInput {
759 /**
760 * The Amazon Resource Name (ARN) of the state machine whose executions is listed.
761 */
762 stateMachineArn: Arn;
763 /**
764 * If specified, only list the executions whose current execution status matches the given filter.
765 */
766 statusFilter?: ExecutionStatus;
767 /**
768 * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
769 */
770 maxResults?: PageSize;
771 /**
772 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
773 */
774 nextToken?: ListExecutionsPageToken;
775 }
776 export interface ListExecutionsOutput {
777 /**
778 * The list of matching executions.
779 */
780 executions: ExecutionList;
781 /**
782 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
783 */
784 nextToken?: ListExecutionsPageToken;
785 }
786 export type ListExecutionsPageToken = string;
787 export interface ListStateMachinesInput {
788 /**
789 * The maximum number of results that are returned per call. You can use nextToken to obtain further pages of results. The default is 100 and the maximum allowed page size is 1000. A value of 0 uses the default. This is only an upper limit. The actual number of results returned per call might be fewer than the specified maximum.
790 */
791 maxResults?: PageSize;
792 /**
793 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
794 */
795 nextToken?: PageToken;
796 }
797 export interface ListStateMachinesOutput {
798 stateMachines: StateMachineList;
799 /**
800 * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.
801 */
802 nextToken?: PageToken;
803 }
804 export interface ListTagsForResourceInput {
805 /**
806 * The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
807 */
808 resourceArn: Arn;
809 }
810 export interface ListTagsForResourceOutput {
811 /**
812 * An array of tags associated with the resource.
813 */
814 tags?: TagList;
815 }
816 export interface MapIterationEventDetails {
817 /**
818 * The name of the iteration’s parent Map state.
819 */
820 name?: Name;
821 /**
822 * The index of the array belonging to the Map state iteration.
823 */
824 index?: UnsignedInteger;
825 }
826 export interface MapStateStartedEventDetails {
827 /**
828 * The size of the array for Map state iterations.
829 */
830 length?: UnsignedInteger;
831 }
832 export type Name = string;
833 export type PageSize = number;
834 export type PageToken = string;
835 export type ReverseOrder = boolean;
836 export interface SendTaskFailureInput {
837 /**
838 * The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
839 */
840 taskToken: TaskToken;
841 /**
842 * The error code of the failure.
843 */
844 error?: SensitiveError;
845 /**
846 * A more detailed explanation of the cause of the failure.
847 */
848 cause?: SensitiveCause;
849 }
850 export interface SendTaskFailureOutput {
851 }
852 export interface SendTaskHeartbeatInput {
853 /**
854 * The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
855 */
856 taskToken: TaskToken;
857 }
858 export interface SendTaskHeartbeatOutput {
859 }
860 export interface SendTaskSuccessInput {
861 /**
862 * The token that represents this task. Task tokens are generated by Step Functions when tasks are assigned to a worker, or in the context object when a workflow enters a task state. See GetActivityTaskOutput$taskToken.
863 */
864 taskToken: TaskToken;
865 /**
866 * The JSON output of the task.
867 */
868 output: SensitiveData;
869 }
870 export interface SendTaskSuccessOutput {
871 }
872 export type SensitiveCause = string;
873 export type SensitiveData = string;
874 export type SensitiveDataJobInput = string;
875 export type SensitiveError = string;
876 export interface StartExecutionInput {
877 /**
878 * The Amazon Resource Name (ARN) of the state machine to execute.
879 */
880 stateMachineArn: Arn;
881 /**
882 * The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
883 */
884 name?: Name;
885 /**
886 * The string that contains the JSON input data for the execution, for example: "input": "{\"first_name\" : \"test\"}" If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"
887 */
888 input?: SensitiveData;
889 }
890 export interface StartExecutionOutput {
891 /**
892 * The Amazon Resource Name (ARN) that identifies the execution.
893 */
894 executionArn: Arn;
895 /**
896 * The date the execution is started.
897 */
898 startDate: Timestamp;
899 }
900 export interface StateEnteredEventDetails {
901 /**
902 * The name of the state.
903 */
904 name: Name;
905 /**
906 * The string that contains the JSON input data for the state.
907 */
908 input?: SensitiveData;
909 }
910 export interface StateExitedEventDetails {
911 /**
912 * The name of the state. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
913 */
914 name: Name;
915 /**
916 * The JSON output data of the state.
917 */
918 output?: SensitiveData;
919 }
920 export type StateMachineList = StateMachineListItem[];
921 export interface StateMachineListItem {
922 /**
923 * The Amazon Resource Name (ARN) that identifies the state machine.
924 */
925 stateMachineArn: Arn;
926 /**
927 * The name of the state machine. A name must not contain: white space brackets &lt; &gt; { } [ ] wildcard characters ? * special characters " # % \ ^ | ~ ` $ &amp; , ; : / control characters (U+0000-001F, U+007F-009F)
928 */
929 name: Name;
930 /**
931 * The date the state machine is created.
932 */
933 creationDate: Timestamp;
934 }
935 export type StateMachineStatus = "ACTIVE"|"DELETING"|string;
936 export interface StopExecutionInput {
937 /**
938 * The Amazon Resource Name (ARN) of the execution to stop.
939 */
940 executionArn: Arn;
941 /**
942 * The error code of the failure.
943 */
944 error?: SensitiveError;
945 /**
946 * A more detailed explanation of the cause of the failure.
947 */
948 cause?: SensitiveCause;
949 }
950 export interface StopExecutionOutput {
951 /**
952 * The date the execution is stopped.
953 */
954 stopDate: Timestamp;
955 }
956 export interface Tag {
957 /**
958 * The key of a tag.
959 */
960 key?: TagKey;
961 /**
962 * The value of a tag.
963 */
964 value?: TagValue;
965 }
966 export type TagKey = string;
967 export type TagKeyList = TagKey[];
968 export type TagList = Tag[];
969 export interface TagResourceInput {
970 /**
971 * The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
972 */
973 resourceArn: Arn;
974 /**
975 * The list of tags to add to a resource. Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.
976 */
977 tags: TagList;
978 }
979 export interface TagResourceOutput {
980 }
981 export type TagValue = string;
982 export interface TaskFailedEventDetails {
983 /**
984 * The action of the resource called by a task state.
985 */
986 resourceType: Name;
987 /**
988 * The service name of the resource in a task state.
989 */
990 resource: Name;
991 /**
992 * The error code of the failure.
993 */
994 error?: SensitiveError;
995 /**
996 * A more detailed explanation of the cause of the failure.
997 */
998 cause?: SensitiveCause;
999 }
1000 export interface TaskScheduledEventDetails {
1001 /**
1002 * The action of the resource called by a task state.
1003 */
1004 resourceType: Name;
1005 /**
1006 * The service name of the resource in a task state.
1007 */
1008 resource: Name;
1009 /**
1010 * The region of the scheduled task
1011 */
1012 region: Name;
1013 /**
1014 * The JSON data passed to the resource referenced in a task state.
1015 */
1016 parameters: ConnectorParameters;
1017 /**
1018 * The maximum allowed duration of the task.
1019 */
1020 timeoutInSeconds?: TimeoutInSeconds;
1021 }
1022 export interface TaskStartFailedEventDetails {
1023 /**
1024 * The action of the resource called by a task state.
1025 */
1026 resourceType: Name;
1027 /**
1028 * The service name of the resource in a task state.
1029 */
1030 resource: Name;
1031 /**
1032 * The error code of the failure.
1033 */
1034 error?: SensitiveError;
1035 /**
1036 * A more detailed explanation of the cause of the failure.
1037 */
1038 cause?: SensitiveCause;
1039 }
1040 export interface TaskStartedEventDetails {
1041 /**
1042 * The action of the resource called by a task state.
1043 */
1044 resourceType: Name;
1045 /**
1046 * The service name of the resource in a task state.
1047 */
1048 resource: Name;
1049 }
1050 export interface TaskSubmitFailedEventDetails {
1051 /**
1052 * The action of the resource called by a task state.
1053 */
1054 resourceType: Name;
1055 /**
1056 * The service name of the resource in a task state.
1057 */
1058 resource: Name;
1059 /**
1060 * The error code of the failure.
1061 */
1062 error?: SensitiveError;
1063 /**
1064 * A more detailed explanation of the cause of the failure.
1065 */
1066 cause?: SensitiveCause;
1067 }
1068 export interface TaskSubmittedEventDetails {
1069 /**
1070 * The action of the resource called by a task state.
1071 */
1072 resourceType: Name;
1073 /**
1074 * The service name of the resource in a task state.
1075 */
1076 resource: Name;
1077 /**
1078 * The response from a resource when a task has started.
1079 */
1080 output?: SensitiveData;
1081 }
1082 export interface TaskSucceededEventDetails {
1083 /**
1084 * The action of the resource called by a task state.
1085 */
1086 resourceType: Name;
1087 /**
1088 * The service name of the resource in a task state.
1089 */
1090 resource: Name;
1091 /**
1092 * The full JSON response from a resource when a task has succeeded. This response becomes the output of the related task.
1093 */
1094 output?: SensitiveData;
1095 }
1096 export interface TaskTimedOutEventDetails {
1097 /**
1098 * The action of the resource called by a task state.
1099 */
1100 resourceType: Name;
1101 /**
1102 * The service name of the resource in a task state.
1103 */
1104 resource: Name;
1105 /**
1106 * The error code of the failure.
1107 */
1108 error?: SensitiveError;
1109 /**
1110 * A more detailed explanation of the cause of the failure.
1111 */
1112 cause?: SensitiveCause;
1113 }
1114 export type TaskToken = string;
1115 export type TimeoutInSeconds = number;
1116 export type Timestamp = Date;
1117 export type UnsignedInteger = number;
1118 export interface UntagResourceInput {
1119 /**
1120 * The Amazon Resource Name (ARN) for the Step Functions state machine or activity.
1121 */
1122 resourceArn: Arn;
1123 /**
1124 * The list of tags to remove from the resource.
1125 */
1126 tagKeys: TagKeyList;
1127 }
1128 export interface UntagResourceOutput {
1129 }
1130 export interface UpdateStateMachineInput {
1131 /**
1132 * The Amazon Resource Name (ARN) of the state machine.
1133 */
1134 stateMachineArn: Arn;
1135 /**
1136 * The Amazon States Language definition of the state machine. See Amazon States Language.
1137 */
1138 definition?: Definition;
1139 /**
1140 * The Amazon Resource Name (ARN) of the IAM role of the state machine.
1141 */
1142 roleArn?: Arn;
1143 }
1144 export interface UpdateStateMachineOutput {
1145 /**
1146 * The date and time the state machine was updated.
1147 */
1148 updateDate: Timestamp;
1149 }
1150 /**
1151 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1152 */
1153 export type apiVersion = "2016-11-23"|"latest"|string;
1154 export interface ClientApiVersions {
1155 /**
1156 * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
1157 */
1158 apiVersion?: apiVersion;
1159 }
1160 export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
1161 /**
1162 * Contains interfaces for use with the StepFunctions client.
1163 */
1164 export import Types = StepFunctions;
1165}
1166export = StepFunctions;