paws (version 0.2.0)

sfn: AWS Step Functions

Description

AWS Step Functions is a service that lets you coordinate the components of distributed applications and microservices using visual workflows.

You can use Step Functions to build applications from individual components, each of which performs a discrete function, or task, 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.

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 <span href="https://docs.aws.amazon.com/step-functions/latest/dg/welcome.html">AWS Step Functions Developer Guide</span> .

Usage

sfn(config = list())

Value

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

• access_key_id: AWS access key ID

• secret_access_key: AWS secret access key

• session_token: AWS temporary session token

• profile: The name of a profile to use. If not given, then the default profile is used.

• anonymous: Set anonymous credentials.

• endpoint: The complete URL to use for the constructed client.

• region: The AWS Region used in instantiating the client.

• close_connection: Immediately close all HTTP connections.

• timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

• s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e., http://s3.amazonaws.com/BUCKET/KEY.

Service syntax

svc <- sfn(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical"
  )
)

Operations

create_activity	Creates an activity
create_state_machine	Creates a state machine
delete_activity	Deletes an activity
delete_state_machine	Deletes a state machine
describe_activity	Describes an activity
describe_execution	Describes an execution
describe_state_machine	Describes a state machine
describe_state_machine_for_execution	Describes the state machine associated with a specific execution
get_activity_task	Used by workers to retrieve a task (with the specified activity ARN) which has been scheduled for execution by a running state machine
get_execution_history	Returns the history of the specified execution as a list of events
list_activities	Lists the existing activities
list_executions	Lists the executions of a state machine that meet the filtering criteria
list_state_machines	Lists the existing state machines
list_tags_for_resource	List tags for a given resource
send_task_failure	Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed
send_task_heartbeat	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
send_task_success	Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully
start_execution	Starts a state machine execution
start_sync_execution	Starts a Synchronous Express state machine execution
stop_execution	Stops an execution
tag_resource	Add a tag to a Step Functions resource
untag_resource	Remove a tag from a Step Functions resource
update_state_machine	Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration

Examples

if (FALSE) {
svc <- sfn()
svc$create_activity(
  Foo = 123
)
}