sfn: AWS Step Functions

In paws: Amazon Web Services Software Development Kit

AWS Step Functions

Description

Step Functions

Step Functions coordinates 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 Amazon Web Services, your own servers, or any system that has access to Amazon Web Services. You can access and use Step Functions using the console, the Amazon Web Services SDKs, or an HTTP API. For more information about Step Functions, see the StepFunctions Developer Guide .

If you use the Step Functions API actions using Amazon Web Services SDK integrations, make sure the API actions are in camel case and parameter names are in Pascal case. For example, you could use Step Functions API action startSyncExecution and specify its parameter as StateMachineArn.

Usage

sfn(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

config	Optional configuration of credentials, endpoint, and/or region. credentials: creds: 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⁠. sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials	Optional credentials shorthand for the config parameter creds: 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	Optional shorthand for complete URL to use for the constructed client.
region	Optional shorthand for AWS Region used in instantiating the client.

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.

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",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

create_activity	Creates an activity
create_state_machine	Creates a state machine
create_state_machine_alias	Creates an alias for a state machine that points to one or two versions of the same state machine
delete_activity	Deletes an activity
delete_state_machine	Deletes a state machine
delete_state_machine_alias	Deletes a state machine alias
delete_state_machine_version	Deletes a state machine version
describe_activity	Describes an activity
describe_execution	Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata
describe_map_run	Provides information about a Map Run's configuration, progress, and results
describe_state_machine	Provides information about a state machine's definition, its IAM role Amazon Resource Name (ARN), and configuration
describe_state_machine_alias	Returns details about a state machine alias
describe_state_machine_for_execution	Provides information about a state machine's definition, its execution role ARN, and configuration
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 all executions of a state machine or a Map Run
list_map_runs	Lists all Map Runs that were started by a given state machine execution
list_state_machine_aliases	Lists aliases for a specified state machine ARN
list_state_machines	Lists the existing state machines
list_state_machine_versions	Lists versions for the specified state machine Amazon Resource Name (ARN)
list_tags_for_resource	List tags for a given resource
publish_state_machine_version	Creates a version from the current revision of a state machine
redrive_execution	Restarts unsuccessful executions of Standard workflows that didn't complete successfully in the last 14 days
send_task_failure	Used by activity workers, Task states using the callback pattern, and optionally Task states using the job run 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, and optionally Task states using the job run 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, Task states using the callback pattern, and optionally Task states using the job run 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
test_state	Accepts the definition of a single state and executes it
untag_resource	Remove a tag from a Step Functions resource
update_map_run	Updates an in-progress Map Run's configuration to include changes to the settings that control maximum concurrency and Map Run failure
update_state_machine	Updates an existing state machine by modifying its definition, roleArn, loggingConfiguration, or EncryptionConfiguration
update_state_machine_alias	Updates the configuration of an existing state machine alias by modifying its description or routingConfiguration
validate_state_machine_definition	Validates the syntax of a state machine definition

Examples

## Not run: 
svc <- sfn()
svc$create_activity(
  Foo = 123
)

## End(Not run)

paws documentation built on Sept. 17, 2024, 5:07 p.m.