|
3 | 3 | "service": "<fullname>AWS Step Functions</fullname> <p>AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.</p> <p>You can use Step Functions to build applications from individual components, each of which performs a discrete function, or <i>task</i>, allowing you to scale and change applications quickly. Step Functions provides a console that helps visualize the components of your application as a series of steps. Step Functions automatically triggers and tracks each step, and retries steps when there are errors, so your application executes predictably and in the right order every time. Step Functions logs the state of each step, so you can quickly diagnose and debug any issues.</p> <p>Step Functions manages operations and underlying infrastructure to ensure your application is available at any scale. You can run tasks on AWS, your own servers, or any system that has access to AWS. You can access and use Step Functions using the console, the AWS SDKs, or an HTTP API. For more information about Step Functions, see the <i> <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html\">AWS Step Functions Developer Guide</a> </i>.</p>", |
4 | 4 | "operations": { |
5 | 5 | "CreateActivity": "<p>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 <code>GetActivityTask</code> API action and respond using <code>SendTask*</code> 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.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateActivity</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateActivity</code>'s idempotency check is based on the activity <code>name</code>. If a following request has different <code>tags</code> values, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>tags</code> will not be updated, even if they are different.</p> </note>", |
6 | | - "CreateStateMachine": "<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html\">Amazon States Language</a> in the AWS Step Functions User Guide.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, and <code>LoggingConfiguration</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>", |
| 6 | + "CreateStateMachine": "<p>Creates a state machine. A state machine consists of a collection of states that can do work (<code>Task</code> states), determine to which states to transition next (<code>Choice</code> states), stop an execution with an error (<code>Fail</code> states), and so on. State machines are specified using a JSON-based, structured language. For more information, see <a href=\"https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html\">Amazon States Language</a> in the AWS Step Functions User Guide.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note> <note> <p> <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency check is based on the state machine <code>name</code>, <code>definition</code>, <code>type</code>, <code>LoggingConfiguration</code> and <code>TracingConfiguration</code>. If a following request has a different <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat it as an idempotent request of the previous. In this case, <code>roleArn</code> and <code>tags</code> will not be updated, even if they are different.</p> </note>", |
7 | 7 | "DeleteActivity": "<p>Deletes an activity.</p>", |
8 | 8 | "DeleteStateMachine": "<p>Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to <code>DELETING</code> and begins the deletion process. </p> <note> <p>For <code>EXPRESS</code>state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after <code>DeleteStateMachine</code> API is called.</p> </note>", |
9 | 9 | "DescribeActivity": "<p>Describes an activity.</p> <note> <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p> </note>", |
|
132 | 132 | } |
133 | 133 | }, |
134 | 134 | "CloudWatchEventsExecutionDataDetails": { |
135 | | - "base": "<p>Provides details about execution input.</p>", |
| 135 | + "base": "<p>Provides details about execution input or output.</p>", |
136 | 136 | "refs": { |
137 | 137 | "DescribeExecutionOutput$inputDetails": null, |
138 | 138 | "DescribeExecutionOutput$outputDetails": null |
|
239 | 239 | "refs": { |
240 | 240 | } |
241 | 241 | }, |
| 242 | + "Enabled": { |
| 243 | + "base": null, |
| 244 | + "refs": { |
| 245 | + "TracingConfiguration$enabled": "<p>When set to <code>true</code>, AWS X-Ray tracing is enabled.</p>" |
| 246 | + } |
| 247 | + }, |
242 | 248 | "ErrorMessage": { |
243 | 249 | "base": null, |
244 | 250 | "refs": { |
|
255 | 261 | "InvalidName$message": null, |
256 | 262 | "InvalidOutput$message": null, |
257 | 263 | "InvalidToken$message": null, |
| 264 | + "InvalidTracingConfiguration$message": null, |
258 | 265 | "MissingRequiredParameter$message": null, |
259 | 266 | "ResourceNotFound$message": null, |
260 | 267 | "StateMachineAlreadyExists$message": null, |
|
366 | 373 | } |
367 | 374 | }, |
368 | 375 | "HistoryEventExecutionDataDetails": { |
369 | | - "base": "<p>Contains details about the data from an execution's events. Always <code>true</code> for API calls, but may be <code>false</code> for CloudWatch Logs.</p>", |
| 376 | + "base": "<p>Provides details about input or output in an execution history event.</p>", |
370 | 377 | "refs": { |
371 | 378 | "ActivityScheduledEventDetails$inputDetails": "<p>Contains details about the input for an execution history event.</p>", |
372 | 379 | "ActivitySucceededEventDetails$outputDetails": "<p>Contains details about the output of an execution history event.</p>", |
|
445 | 452 | "refs": { |
446 | 453 | } |
447 | 454 | }, |
| 455 | + "InvalidTracingConfiguration": { |
| 456 | + "base": "<p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not been set to <code>true</code> or <code>false</code>.</p>", |
| 457 | + "refs": { |
| 458 | + } |
| 459 | + }, |
448 | 460 | "LambdaFunctionFailedEventDetails": { |
449 | 461 | "base": "<p>Contains details about a lambda function that failed during an execution.</p>", |
450 | 462 | "refs": { |
|
968 | 980 | "refs": { |
969 | 981 | } |
970 | 982 | }, |
| 983 | + "TraceHeader": { |
| 984 | + "base": null, |
| 985 | + "refs": { |
| 986 | + "DescribeExecutionOutput$traceHeader": "<p>The AWS X-Ray trace header which was passed to the execution.</p>", |
| 987 | + "StartExecutionInput$traceHeader": "<p>Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.</p>" |
| 988 | + } |
| 989 | + }, |
| 990 | + "TracingConfiguration": { |
| 991 | + "base": "<p>Selects whether or not the state machine's AWS X-Ray tracing is enabled. Default is <code>false</code> </p>", |
| 992 | + "refs": { |
| 993 | + "CreateStateMachineInput$tracingConfiguration": "<p>Selects whether AWS X-Ray tracing is enabled.</p>", |
| 994 | + "DescribeStateMachineForExecutionOutput$tracingConfiguration": "<p>Selects whether AWS X-Ray tracing is enabled.</p>", |
| 995 | + "DescribeStateMachineOutput$tracingConfiguration": "<p>Selects whether AWS X-Ray tracing is enabled.</p>", |
| 996 | + "UpdateStateMachineInput$tracingConfiguration": "<p>Selects whether AWS X-Ray tracing is enabled.</p>" |
| 997 | + } |
| 998 | + }, |
971 | 999 | "UnsignedInteger": { |
972 | 1000 | "base": null, |
973 | 1001 | "refs": { |
|
998 | 1026 | "included": { |
999 | 1027 | "base": null, |
1000 | 1028 | "refs": { |
1001 | | - "CloudWatchEventsExecutionDataDetails$included": "<p>Indicates whether input or output was included in the response. Always <code>true</code> for API calls, but may be <code>false</code> for CloudWatch Events.</p>" |
| 1029 | + "CloudWatchEventsExecutionDataDetails$included": "<p>Indicates whether input or output was included in the response. Always <code>true</code> for API calls. </p>" |
1002 | 1030 | } |
1003 | 1031 | }, |
1004 | 1032 | "truncated": { |
1005 | 1033 | "base": null, |
1006 | 1034 | "refs": { |
1007 | | - "HistoryEventExecutionDataDetails$truncated": "<p>Indicates whether input or output was truncated in the response. Always <code>false</code>.</p>" |
| 1035 | + "HistoryEventExecutionDataDetails$truncated": "<p>Indicates whether input or output was truncated in the response. Always <code>false</code> for API calls.</p>" |
1008 | 1036 | } |
1009 | 1037 | } |
1010 | 1038 | } |
|
0 commit comments