AWS amazonswf documentation change
Summary
Multiple editorial changes including grammar fixes, clarifications about activity registration timeouts, worker implementations, and regional endpoint descriptions. Enhanced explanations of workflow execution and SDK integrations.
Security assessment
Changes are primarily grammatical improvements, clarifications, and expanded examples. The IAM access control section adds a minor clarification about controlled access but does not address a specific security vulnerability or introduce new security documentation.
Diff
diff --git a/amazonswf/latest/developerguide/intro.md b/amazonswf/latest/developerguide/intro.md index eb093c79c..d78f5de39 100644 --- a/amazonswf/latest/developerguide/intro.md +++ b/amazonswf/latest/developerguide/intro.md @@ -9 +9 @@ Workflow componentsRunning your workflowSetting up your development environmentD -Developing distributed applications requires coordinating many components and dealing with latency and unreliability inherent in remote communication. +Developing distributed applications requires coordinating many components and dealing with latencies and unreliability inherent in remote communication. @@ -15 +15 @@ With Amazon Simple Workflow Service (Amazon SWF), you can develop asynchronous a -Components of a workflow The fundamental concept in Amazon SWF is the _workflow_. A workflow is a set of _activities_ that carry out some objective, together with logic that coordinates the activities. For example, a workflow could receive a customer order and take whatever actions are necessary to fulfill the order. +The fundamental concept in Amazon SWF is the _workflow_. A workflow is a set of _activities_ that carry out some objective, together with logic that coordinates the activities. For example, a workflow could receive a customer order and take whatever actions are necessary to fulfill the order. @@ -19 +19 @@ Each workflow runs in a resource called a _domain_ , which controls the workflow -When designing an Amazon SWF workflow, you define each of the required activities. You then register each activity with Amazon SWF as an activity type. You will provide a name, version, and timeout values. For example, a customer may have an expectation that an order will ship within 24 hours. +When designing an Amazon SWF workflow, you precisely define each of the required activities. You then register each activity with Amazon SWF as an activity type. When you register the activity, you provide information such as a name and version, and some timeout values based on how long you expect the activity to take. For example, a customer may have an expectation that an order will ship within 24 hours, which you will consider when registering activity timeout values. @@ -23 +23 @@ In the process of carrying out the workflow, some activities may need to be perf -An _activity worker_ is a program that receives activity tasks, performs them, and provides results. The task might actually be performed by a person. For example, a statistical analyst might receive sets of data, analyze the data, and then send back their analysis. +An _activity worker_ is a program that receives activity tasks, performs them, and provides results back. Note that the task itself might actually be performed by a person, in which case the person would use the activity worker software for the receipt and disposition of the task. An example might be a statistical analyst, who receives sets of data, analyzes them, and then sends back the analysis. @@ -25 +25 @@ An _activity worker_ is a program that receives activity tasks, performs them, a -Activity tasks, and the activity workers that perform them, can run synchronously or asynchronously. Workers can run in one location or be distributed across multiple computers, potentially in different geographic regions. Different activity workers can be written in different programming languages and run on different operating systems. For example, one activity worker might be running on a server in Asia, while another might be running on a mobile device in North America. +Activity tasks—and the activity workers that perform them—can run synchronously or asynchronously. They can be distributed across multiple computers, potentially in different geographic regions, or they can all run on the same computer. Different activity workers can be written in different programming languages and run on different operating systems. For example, one activity worker might be running on a desktop computer in Asia, whereas a different activity worker might be running on a hand-held computer device in North America. @@ -27 +27 @@ Activity tasks, and the activity workers that perform them, can run synchronousl -The coordination logic in a workflow is contained in a software program called a _decider_. A decider schedules activity tasks, provides input to activity workers, processes events that arrive while the workflow is in progress, and ends (or closes) the workflow after the objective has been met. +The coordination logic in a workflow is contained in a software program called a _decider_. The decider schedules activity tasks, provides input data to the activity workers, processes events that arrive while the workflow is in progress, and ultimately ends (or closes) the workflow when the objective has been completed. @@ -31 +31 @@ The role of the Amazon SWF service is to function as a reliable central hub thro -The decider directs the workflow by receiving decision tasks from Amazon SWF and responding back to Amazon SWF with decisions. A decision represents an action or set of actions, which are the next steps in the workflow. A typical decision would be to schedule an activity task. Decisions can also be used to delay tasks with timers, request cancellation of in-progress tasks, and to complete workflows. +The decider directs the workflow by receiving decision tasks from Amazon SWF and responding back to Amazon SWF with decisions. A decision represents an action or set of actions which are the next steps in the workflow. A typical decision would be to schedule an activity task. Decisions can also be used to set timers to delay the execution of an activity task, to request cancellation of activity tasks already in progress, and to complete or close the workflow. @@ -35 +35 @@ The mechanism by which both the activity workers and the decider receive their t -Amazon SWF informs the decider of the state of the workflow by including, with each decision task, a copy of the current workflow execution history. The workflow execution history is composed of events, where an event represents a significant change in the state of the workflow execution. Examples of events include task completion, task time outs, or the expiration of a timer. The history is a complete, consistent, and authoritative record of the workflow's progress. +Amazon SWF informs the decider of the state of the workflow by including, with each decision task, a copy of the current workflow execution history. The workflow execution history is composed of events, where an event represents a significant change in the state of the workflow execution. Examples of events would be the completion of a task, notification that a task has timed out, or the expiration of a timer that was set earlier in the workflow execution. The history is a complete, consistent, and authoritative record of the workflow's progress. @@ -37 +37 @@ Amazon SWF informs the decider of the state of the workflow by including, with e -Amazon SWF access control uses AWS Identity and Access Management (IAM), so you can control access to AWS resources. For example, you can allow a user to access your account, but only to run certain workflows in a particular domain. +Amazon SWF access control uses AWS Identity and Access Management (IAM), which allows you to provide access to AWS resources in a controlled and limited way. For example, you can allow a user to access your account, but only to run certain workflows in a particular domain. @@ -57 +57 @@ These actors can run on any computing device that can access an Amazon SWF endpo -You can start workflows programmatically or via the AWS Management Console. +Executions can be initiated either programmatically or via the AWS Management Console. @@ -59 +59 @@ You can start workflows programmatically or via the AWS Management Console. -Each execution runs independently and you can provide each with its own set of input data. When an execution is started, Amazon SWF schedules the initial decision task. In response, your decider begins generating decisions that initiate activity tasks. Execution continues until your decider makes a decision to close the execution. +Each execution runs independently and you can provide each with its own set of input data. When an execution is started, Amazon SWF schedules the initial decision task. In response, your decider begins generating decisions which initiate activity tasks. Execution continues until your decider makes a decision to close the execution. @@ -63 +63 @@ Each execution runs independently and you can provide each with its own set of i -You can filter and view complete details of running and completed executions. For example, you can select an open execution to see which tasks have been completed and what their results were. +You can filter and view complete details of running as well as completed executions. For example, you can select an open execution to see which tasks have completed and what their results were. @@ -72 +72 @@ You have the option of developing for Amazon SWF in any of the programming langu -To reduce latency and to store data in a location that meets your requirements, Amazon SWF provides **endpoints** in different Regions. +To reduce latency and to store data in a location that meets your requirements, Amazon SWF provides **endpoints** in different regions. @@ -74 +74 @@ To reduce latency and to store data in a location that meets your requirements, -Each endpoint in Amazon SWF is completely independent. Any domains, workflows, and activities you have registered in one Region will not share data or attributes with those in another Region. +Each endpoint in Amazon SWF is completely independent. Any domains, workflows and activities you have registered in one region will not share data or attributes with those in another region. @@ -76 +76 @@ Each endpoint in Amazon SWF is completely independent. Any domains, workflows, a -When you register an Amazon SWF domain, workflow, or activity, it exists _only within the Region you registered it in_. For example, you could register a domain named `SWF-Flows-1` in two different Regions, but they will share no data or attributes with each other — each acting as a completely independent domain. +When you register an Amazon SWF domain, workflow or activity, it exists _only within the region you registered it in_. For example, you could register a domain named `SWF-Flows-1` in two different regions, but they will share no data or attributes with each other—each acts as a completely independent domain. @@ -82 +82 @@ For a list of Amazon SWF endpoints, see [Regions and Endpoints](https://docs.aws -Amazon SWF is supported by the AWS SDKs for Java, .NET, Node.js, PHP, Python, and Ruby, providing a convenient way to use the Amazon SWF HTTP API in the programming language of your choice. +Amazon SWF is supported by the AWS SDKs for Java, .NET, Node.js, PHP, Python and Ruby, providing a convenient way to use the Amazon SWF HTTP API in the programming language of your choice. @@ -88 +88 @@ To download tools for developing and managing applications on AWS, including SDK -For detailed information about the Amazon SWF operations in each SDK, refer to the language-specific reference documentation for the SDK. +For detailed information about the Amazon SWF methods in each SDK, refer to the language-specific reference documentation for the SDK. @@ -94 +94 @@ The AWS Flow Framework is an enhanced SDK for writing distributed, asynchronous -With the AWS Flow Framework, you use preconfigured types to map the definition of your workflow directly to methods in your program. The AWS Flow Framework supports standard object-oriented concepts, such as exception-based error handling. Programs written with the AWS Flow Framework can be created, run, and debugged entirely within your preferred editor or IDE. For more information, see the [AWS Flow Framework](https://aws.amazon.com/swf/flow/) website, and see [AWS Flow Framework for Java Developer Guide](https://docs.aws.amazon.com/amazonswf/latest/awsflowguide/). +With the AWS Flow Framework, you use preconfigured types to map the definition of your workflow directly to methods in your program. The AWS Flow Framework supports standard object-oriented concepts, such as exception-based error handling, which makes it easier to implement complex workflows. Programs written with the AWS Flow Framework can be created, run, and debugged entirely within your preferred editor or IDE. For more information, see the [AWS Flow Framework](https://aws.amazon.com/swf/flow/) website, and see [AWS Flow Framework for Java Developer Guide](https://docs.aws.amazon.com/amazonswf/latest/awsflowguide/).