You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::States::Client

Inherits:

Seahorse::Client::Base

Object
Seahorse::Client::Base
Aws::States::Client

show all

Defined in:: (unknown)

Overview

An API client for AWS Step Functions. To construct a client, you need to configure a :region and :credentials.

states = Aws::States::Client.new(
  region: region_name,
  credentials: credentials,
  # ...
)

See #initialize for a full list of supported configuration options.

Region

You can configure a default region in the following locations:

ENV['AWS_REGION']
Aws.config[:region]

Go here for a list of supported regions.

Credentials

Default credentials are loaded automatically from the following locations:

ENV['AWS_ACCESS_KEY_ID'] and ENV['AWS_SECRET_ACCESS_KEY']
Aws.config[:credentials]
The shared credentials ini file at ~/.aws/credentials (more information)
From an instance profile when running on EC2

You can also construct a credentials object from one of the following classes:

Alternatively, you configure credentials with :access_key_id and :secret_access_key:

# load credentials from disk
creds = YAML.load(File.read('/path/to/secrets'))

Aws::States::Client.new(
  access_key_id: creds['access_key_id'],
  secret_access_key: creds['secret_access_key']
)

Always load your credentials from outside your application. Avoid configuring credentials statically and never commit them to source control.

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

Constructor collapse

#initialize(options = {}) ⇒ Aws::States::Client constructor
Constructs an API client.

API Operations collapse

#create_activity(options = {}) ⇒ Types::CreateActivityOutput
Creates an activity.
#create_state_machine(options = {}) ⇒ Types::CreateStateMachineOutput
Creates a state machine.
#delete_activity(options = {}) ⇒ Struct
Deletes an activity.

.
#delete_state_machine(options = {}) ⇒ Struct
Deletes a state machine.
#describe_activity(options = {}) ⇒ Types::DescribeActivityOutput
Describes an activity.

This operation is eventually consistent.
#describe_execution(options = {}) ⇒ Types::DescribeExecutionOutput
Describes an execution.

This operation is eventually consistent.
#describe_state_machine(options = {}) ⇒ Types::DescribeStateMachineOutput
Describes a state machine.

This operation is eventually consistent.
#describe_state_machine_for_execution(options = {}) ⇒ Types::DescribeStateMachineForExecutionOutput
Describes the state machine associated with a specific execution.

This operation is eventually consistent.
#get_activity_task(options = {}) ⇒ Types::GetActivityTaskOutput
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(options = {}) ⇒ Types::GetExecutionHistoryOutput
Returns the history of the specified execution as a list of events.
#list_activities(options = {}) ⇒ Types::ListActivitiesOutput
Lists the existing activities.

If nextToken is returned, there are more results available.
#list_executions(options = {}) ⇒ Types::ListExecutionsOutput
Lists the executions of a state machine that meet the filtering criteria.
#list_state_machines(options = {}) ⇒ Types::ListStateMachinesOutput
Lists the existing state machines.

If nextToken is returned, there are more results available.
#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceOutput
List tags for a given resource.

Tags may only contain Unicode letters, digits, white space, or these symbols: _ .



      
        
  
    
      #send_task_failure(options = {})  ⇒ Struct 
    

    
  
  
  
  
  
  
  
  

  
    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.


.

  


      
        
  
    
      #send_task_heartbeat(options = {})  ⇒ Struct 
    

    
  
  
  
  
  
  
  
  

  
    
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(options = {})  ⇒ Struct 
    

    
  
  
  
  
  
  
  
  

  
    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.


.

  


      
        
  
    
      #start_execution(options = {})  ⇒ Types::StartExecutionOutput 
    

    
  
  
  
  
  
  
  
  

  
    Starts a state machine execution.


  
 StartExecution is idempotent.

  


      
        
  
    
      #stop_execution(options = {})  ⇒ Types::StopExecutionOutput 
    

    
  
  
  
  
  
  
  
  

  
    Stops an execution.


 
This API action is not supported by EXPRESS state machines.
.

  


      
        
  
    
      #tag_resource(options = {})  ⇒ Struct 
    

    
  
  
  
  
  
  
  
  

  
    Add a tag to a Step Functions resource.


 
An array of key-value pairs.

  


      
        
  
    
      #untag_resource(options = {})  ⇒ Struct 
    

    
  
  
  
  
  
  
  
  

  
    Remove a tag from a Step Functions resource


.

  


      
        
  
    
      #update_state_machine(options = {})  ⇒ Types::UpdateStateMachineOutput 
    

    
  
  
  
  
  
  
  
  

  
    
Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration.


  
    
      Instance Method Summary
      collapse
    

    
      
        
  
    
      #wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean 
    

    
  
  
  
  
  
  
  
  

  
    Waiters polls an API operation until a resource enters a desired state.

  


      
        
  
    
      #waiter_names  ⇒ Array<Symbol> 
    

    
  
  
  
  
  
  
  
  

  
    Returns the list of supported waiters.

  


      
    
  


  
  
  
  
  
  
  
  
  Methods inherited from Seahorse::Client::Base
  add_plugin, api, #build_request, clear_plugins, define, new, #operation, #operation_names, plugins, remove_plugin, set_api, set_plugins

  
  
  
  
  
  
  
  
  Methods included from Seahorse::Client::HandlerBuilder
  #handle, #handle_request, #handle_response

  Constructor Details
  
    
  
  
    #initialize(options = {})  ⇒ Aws::States::Client 
  

  

  

  
    Constructs an API client.


  


  
  
    
    
    Options Hash (options):
    
      
        
          :access_key_id
          (String)
          
            
          
          
            — Used to set credentials
statically.  See Plugins::RequestSigner for more details.

          
        
      
        
          :active_endpoint_cache
          (Boolean)
          
            
          
          
            — When set to true, a thread polling for endpoints will be running in
the background every 60 secs (default). Defaults to false.  See Plugins::EndpointDiscovery for more details.

          
        
      
        
          :convert_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — When true, an attempt is made to coerce request parameters
into the required types.  See Plugins::ParamConverter for more details.

          
        
      
        
          :credentials
          (required, Credentials)
          
            
          
          
            — Your
AWS credentials.  The following locations will be searched in order
for credentials:


:access_key_id, :secret_access_key, and :session_token options
ENV['AWS_ACCESS_KEY_ID'], ENV['AWS_SECRET_ACCESS_KEY']
HOME/.aws/credentials shared credentials file
EC2 instance profile credentials  See Plugins::RequestSigner for more details.



          
        
      
        
          :disable_host_prefix_injection
          (Boolean)
          
            
          
          
            — Set to true to disable SDK automatically adding host prefix
to default service endpoint when available.  See Plugins::EndpointPattern for more details.

          
        
      
        
          :endpoint
          (String)
          
            
          
          
            — A default endpoint is
constructed from the :region.  See Plugins::RegionalEndpoint for more details.

          
        
      
        
          :endpoint_cache_max_entries
          (Integer)
          
            
          
          
            — Used for the maximum size limit of the LRU cache storing endpoints data
for endpoint discovery enabled operations. Defaults to 1000.  See Plugins::EndpointDiscovery for more details.

          
        
      
        
          :endpoint_cache_max_threads
          (Integer)
          
            
          
          
            — Used for the maximum threads in use for polling endpoints to be cached,
defaults to 10.  See Plugins::EndpointDiscovery for more details.

          
        
      
        
          :endpoint_cache_poll_interval
          (Integer)
          
            
          
          
            — When :endpoint_discovery and :active_endpoint_cache is enabled,
Use this option to config the time interval in seconds for making
requests fetching endpoints information. Defaults to 60 sec.  See Plugins::EndpointDiscovery for more details.

          
        
      
        
          :endpoint_discovery
          (Boolean)
          
            
          
          
            — When
set to true, endpoint discovery will be enabled for
operations when available. Defaults to false.  See Plugins::EndpointDiscovery for more details.

          
        
      
        
          :http_continue_timeout
          (Float)
          
            
              — default:
              1
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :http_idle_timeout
          (Integer)
          
            
              — default:
              5
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :http_open_timeout
          (Integer)
          
            
              — default:
              15
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :http_proxy
          (String)
          
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :http_read_timeout
          (Integer)
          
            
              — default:
              60
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :http_wire_trace
          (Boolean)
          
            
              — default:
              false
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :log_level
          (Symbol)
          
            
              — default:
              :info
            
          
          
            — The log level
to send messages to the logger at.  See Plugins::Logging for more details.

          
        
      
        
          :log_formatter
          (Logging::LogFormatter)
          
            
          
          
            — The log
formatter.  Defaults to Seahorse::Client::Logging::Formatter.default.  See Plugins::Logging for more details.

          
        
      
        
          :logger
          (Logger)
          
            
              — default:
              nil
            
          
          
            — The Logger instance
to send log messages to.  If this option is not set, logging
will be disabled.  See Plugins::Logging for more details.

          
        
      
        
          :profile
          (String)
          
            
          
          
            — Used when loading credentials
from the shared credentials file at HOME/.aws/credentials.  When not
specified, 'default' is used.  See Plugins::RequestSigner for more details.

          
        
      
        
          :raise_response_errors
          (Boolean)
          
            
              — default:
              true
            
          
          
            — When true, response errors are raised.  See Seahorse::Client::Plugins::RaiseResponseErrors for more details.

          
        
      
        
          :region
          (required, String)
          
            
          
          
            — The AWS region to connect to.  The region is used to construct
the client endpoint.  Defaults to ENV['AWS_REGION'].
Also checks AMAZON_REGION and AWS_DEFAULT_REGION.  See Plugins::RegionalEndpoint for more details.

          
        
      
        
          :retry_limit
          (Integer)
          
            
              — default:
              3
            
          
          
            — The maximum number of times to retry failed requests.  Only
~ 500 level server errors and certain ~ 400 level client errors
are retried.  Generally, these are throttling errors, data
checksum errors, networking errors, timeout errors and auth
errors from expired credentials.  See Plugins::RetryErrors for more details.

          
        
      
        
          :secret_access_key
          (String)
          
            
          
          
            — Used to set
credentials statically.  See Plugins::RequestSigner for more details.

          
        
      
        
          :session_token
          (String)
          
            
          
          
            — Used to set credentials
statically.  See Plugins::RequestSigner for more details.

          
        
      
        
          :simple_json
          (Boolean)
          
            
              — default:
              false
            
          
          
            — Disables request parameter conversion, validation, and formatting.
Also disable response data type conversions. This option is useful
when you want to ensure the highest level of performance by
avoiding overhead of walking request parameters and response data
structures.

When :simple_json is enabled, the request parameters hash must
be formatted exactly as the DynamoDB API expects.  See Plugins::Protocols::JsonRpc for more details.

          
        
      
        
          :ssl_ca_bundle
          (String)
          
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :ssl_ca_directory
          (String)
          
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :ssl_ca_store
          (String)
          
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :ssl_verify_peer
          (Boolean)
          
            
              — default:
              true
            
          
          
            — See Seahorse::Client::Plugins::NetHttp for more details.

          
        
      
        
          :stub_responses
          (Boolean)
          
            
              — default:
              false
            
          
          
            — Causes the client to return stubbed responses. By default
fake responses are generated and returned. You can specify
the response data to return or errors to raise by calling
ClientStubs#stub_responses. See ClientStubs for more information.

 Please note  When response stubbing is enabled, no HTTP
requests are made, and retries are disabled.  See Plugins::StubResponses for more details.

          
        
      
        
          :validate_params
          (Boolean)
          
            
              — default:
              true
            
          
          
            — When true, request parameters are validated before
sending the request.  See Plugins::ParamValidator for more details.

          
        
      
    
  




  



  
    Instance Method Details

    
      
  
  
    #create_activity(options = {})  ⇒ Types::CreateActivityOutput 
  

  

  

  
    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.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.create_activity({
  name: "Name", # required
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})
    
      
        
Response structure

      
      
resp.activity_arn #=> String
resp.creation_date #=> Time
    
  

  
    
    
    Options Hash (options):
    
      
        
          :name
          (required, String)
          
            
          
          
            — 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 < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)



To enable logging with CloudWatch Logs, the name should only contain
0-9, A-Z, a-z, - and _.

          
        
      
        
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 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: _ . : / = + - @.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::CreateActivityOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#activity_arn => String
#creation_date => Time



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #create_state_machine(options = {})  ⇒ Types::CreateStateMachineOutput 
  

  

  

  
    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. For more information, see Amazon States Language in the AWS Step Functions User Guide.


  
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, definition, type, LoggingConfiguration and TracingConfiguration. 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.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.create_state_machine({
  name: "Name", # required
  definition: "Definition", # required
  role_arn: "Arn", # required
  type: "STANDARD", # accepts STANDARD, EXPRESS
  logging_configuration: {
    level: "ALL", # accepts ALL, ERROR, FATAL, OFF
    include_execution_data: false,
    destinations: [
      {
        cloud_watch_logs_log_group: {
          log_group_arn: "Arn",
        },
      },
    ],
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  tracing_configuration: {
    enabled: false,
  },
})
    
      
        
Response structure

      
      
resp.state_machine_arn #=> String
resp.creation_date #=> Time
    
  

  
    
    
    Options Hash (options):
    
      
        
          :name
          (required, String)
          
            
          
          
            — The name of the state machine.

A name must not contain:


white space
brackets < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)



To enable logging with CloudWatch Logs, the name should only contain
0-9, A-Z, a-z, - and _.

          
        
      
        
          :definition
          (required, String)
          
            
          
          
            — The Amazon States Language definition of the state machine. See Amazon
States Language.

          
        
      
        
          :role_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the IAM role to use for this state
machine.

          
        
      
        
          :type
          (String)
          
            
          
          
            — Determines whether a Standard or Express state machine is created. The
default is STANDARD. You cannot update the type of a state machine
once it has been created.

          
        
      
        
          :logging_configuration
          (Types::LoggingConfiguration)
          
            
          
          
            — Defines what execution history events are logged and where they are
logged.

 By default, the level is set to OFF. For more information see Log
Levels in the AWS Step Functions User Guide.

 

          
        
      
        
          :tags
          (Array<Types::Tag>)
          
            
          
          
            — 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: _ . : / = + - @.

          
        
      
        
          :tracing_configuration
          (Types::TracingConfiguration)
          
            
          
          
            — Selects whether AWS X-Ray tracing is enabled.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::CreateStateMachineOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#state_machine_arn => String
#creation_date => Time



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #delete_activity(options = {})  ⇒ Struct 
  

  

  

  
    Deletes an activity.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.delete_activity({
  activity_arn: "Arn", # required
})
    
  

  
    
    
    Options Hash (options):
    
      
        
          :activity_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the activity to delete.

          
        
      
    
  

Returns:

  
    
      
      
        (Struct)
      
      
      
        —
        Returns an empty response.

      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #delete_state_machine(options = {})  ⇒ Struct 
  

  

  

  
    Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. 


  
For EXPRESSstate machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after DeleteStateMachine API is called.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.delete_state_machine({
  state_machine_arn: "Arn", # required
})
    
  

  
    
    
    Options Hash (options):
    
      
        
          :state_machine_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the state machine to delete.

          
        
      
    
  

Returns:

  
    
      
      
        (Struct)
      
      
      
        —
        Returns an empty response.

      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #describe_activity(options = {})  ⇒ Types::DescribeActivityOutput 
  

  

  

  
    Describes an activity.


  
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.describe_activity({
  activity_arn: "Arn", # required
})
    
      
        
Response structure

      
      
resp.activity_arn #=> String
resp.name #=> String
resp.creation_date #=> Time
    
  

  
    
    
    Options Hash (options):
    
      
        
          :activity_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the activity to describe.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::DescribeActivityOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#activity_arn => String
#name => String
#creation_date => Time



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #describe_execution(options = {})  ⇒ Types::DescribeExecutionOutput 
  

  

  

  
    Describes an execution.


  
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
  This API action is not supported by EXPRESS state machines.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.describe_execution({
  execution_arn: "Arn", # required
})
    
      
        
Response structure

      
      
resp.execution_arn #=> String
resp.state_machine_arn #=> String
resp.name #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED"
resp.start_date #=> Time
resp.stop_date #=> Time
resp.input #=> String
resp.input_details.included #=> true/false
resp.output #=> String
resp.output_details.included #=> true/false
resp.trace_header #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :execution_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the execution to describe.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::DescribeExecutionOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#execution_arn => String
#state_machine_arn => String
#name => String
#status => String
#start_date => Time
#stop_date => Time
#input => String
#input_details => Types::CloudWatchEventsExecutionDataDetails
#output => String
#output_details => Types::CloudWatchEventsExecutionDataDetails
#trace_header => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #describe_state_machine(options = {})  ⇒ Types::DescribeStateMachineOutput 
  

  

  

  
    Describes a state machine.


  
This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.describe_state_machine({
  state_machine_arn: "Arn", # required
})
    
      
        
Response structure

      
      
resp.state_machine_arn #=> String
resp.name #=> String
resp.status #=> String, one of "ACTIVE", "DELETING"
resp.definition #=> String
resp.role_arn #=> String
resp.type #=> String, one of "STANDARD", "EXPRESS"
resp.creation_date #=> Time
resp.logging_configuration.level #=> String, one of "ALL", "ERROR", "FATAL", "OFF"
resp.logging_configuration.include_execution_data #=> true/false
resp.logging_configuration.destinations #=> Array
resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
resp.tracing_configuration.enabled #=> true/false
    
  

  
    
    
    Options Hash (options):
    
      
        
          :state_machine_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the state machine to describe.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::DescribeStateMachineOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#state_machine_arn => String
#name => String
#status => String
#definition => String
#role_arn => String
#type => String
#creation_date => Time
#logging_configuration => Types::LoggingConfiguration
#tracing_configuration => Types::TracingConfiguration



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #describe_state_machine_for_execution(options = {})  ⇒ Types::DescribeStateMachineForExecutionOutput 
  

  

  

  
    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.
  This API action is not supported by EXPRESS state machines.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.describe_state_machine_for_execution({
  execution_arn: "Arn", # required
})
    
      
        
Response structure

      
      
resp.state_machine_arn #=> String
resp.name #=> String
resp.definition #=> String
resp.role_arn #=> String
resp.update_date #=> Time
resp.logging_configuration.level #=> String, one of "ALL", "ERROR", "FATAL", "OFF"
resp.logging_configuration.include_execution_data #=> true/false
resp.logging_configuration.destinations #=> Array
resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
resp.tracing_configuration.enabled #=> true/false
    
  

  
    
    
    Options Hash (options):
    
      
        
          :execution_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the execution you want state machine
information for.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::DescribeStateMachineForExecutionOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#state_machine_arn => String
#name => String
#definition => String
#role_arn => String
#update_date => Time
#logging_configuration => Types::LoggingConfiguration
#tracing_configuration => Types::TracingConfiguration



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #get_activity_task(options = {})  ⇒ Types::GetActivityTaskOutput 
  

  

  

  
    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.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.get_activity_task({
  activity_arn: "Arn", # required
  worker_name: "Name",
})
    
      
        
Response structure

      
      
resp.task_token #=> String
resp.input #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :activity_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the activity to retrieve tasks from
(assigned when you create the task using CreateActivity.)

          
        
      
        
          :worker_name
          (String)
          
            
          
          
            — 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.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::GetActivityTaskOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#task_token => String
#input => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #get_execution_history(options = {})  ⇒ Types::GetExecutionHistoryOutput 
  

  

  

  
    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.
 This API action is not supported by EXPRESS state machines.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.get_execution_history({
  execution_arn: "Arn", # required
  max_results: 1,
  reverse_order: false,
  next_token: "PageToken",
  include_execution_data: false,
})
    
      
        
Response structure

      
      
resp.events #=> Array
resp.events[0].timestamp #=> Time
resp.events[0].type #=> String, one of "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"
resp.events[0].id #=> Integer
resp.events[0].previous_event_id #=> Integer
resp.events[0].activity_failed_event_details.error #=> String
resp.events[0].activity_failed_event_details.cause #=> String
resp.events[0].activity_schedule_failed_event_details.error #=> String
resp.events[0].activity_schedule_failed_event_details.cause #=> String
resp.events[0].activity_scheduled_event_details.resource #=> String
resp.events[0].activity_scheduled_event_details.input #=> String
resp.events[0].activity_scheduled_event_details.input_details.truncated #=> true/false
resp.events[0].activity_scheduled_event_details.timeout_in_seconds #=> Integer
resp.events[0].activity_scheduled_event_details.heartbeat_in_seconds #=> Integer
resp.events[0].activity_started_event_details.worker_name #=> String
resp.events[0].activity_succeeded_event_details.output #=> String
resp.events[0].activity_succeeded_event_details.output_details.truncated #=> true/false
resp.events[0].activity_timed_out_event_details.error #=> String
resp.events[0].activity_timed_out_event_details.cause #=> String
resp.events[0].task_failed_event_details.resource_type #=> String
resp.events[0].task_failed_event_details.resource #=> String
resp.events[0].task_failed_event_details.error #=> String
resp.events[0].task_failed_event_details.cause #=> String
resp.events[0].task_scheduled_event_details.resource_type #=> String
resp.events[0].task_scheduled_event_details.resource #=> String
resp.events[0].task_scheduled_event_details.region #=> String
resp.events[0].task_scheduled_event_details.parameters #=> String
resp.events[0].task_scheduled_event_details.timeout_in_seconds #=> Integer
resp.events[0].task_scheduled_event_details.heartbeat_in_seconds #=> Integer
resp.events[0].task_start_failed_event_details.resource_type #=> String
resp.events[0].task_start_failed_event_details.resource #=> String
resp.events[0].task_start_failed_event_details.error #=> String
resp.events[0].task_start_failed_event_details.cause #=> String
resp.events[0].task_started_event_details.resource_type #=> String
resp.events[0].task_started_event_details.resource #=> String
resp.events[0].task_submit_failed_event_details.resource_type #=> String
resp.events[0].task_submit_failed_event_details.resource #=> String
resp.events[0].task_submit_failed_event_details.error #=> String
resp.events[0].task_submit_failed_event_details.cause #=> String
resp.events[0].task_submitted_event_details.resource_type #=> String
resp.events[0].task_submitted_event_details.resource #=> String
resp.events[0].task_submitted_event_details.output #=> String
resp.events[0].task_submitted_event_details.output_details.truncated #=> true/false
resp.events[0].task_succeeded_event_details.resource_type #=> String
resp.events[0].task_succeeded_event_details.resource #=> String
resp.events[0].task_succeeded_event_details.output #=> String
resp.events[0].task_succeeded_event_details.output_details.truncated #=> true/false
resp.events[0].task_timed_out_event_details.resource_type #=> String
resp.events[0].task_timed_out_event_details.resource #=> String
resp.events[0].task_timed_out_event_details.error #=> String
resp.events[0].task_timed_out_event_details.cause #=> String
resp.events[0].execution_failed_event_details.error #=> String
resp.events[0].execution_failed_event_details.cause #=> String
resp.events[0].execution_started_event_details.input #=> String
resp.events[0].execution_started_event_details.input_details.truncated #=> true/false
resp.events[0].execution_started_event_details.role_arn #=> String
resp.events[0].execution_succeeded_event_details.output #=> String
resp.events[0].execution_succeeded_event_details.output_details.truncated #=> true/false
resp.events[0].execution_aborted_event_details.error #=> String
resp.events[0].execution_aborted_event_details.cause #=> String
resp.events[0].execution_timed_out_event_details.error #=> String
resp.events[0].execution_timed_out_event_details.cause #=> String
resp.events[0].map_state_started_event_details.length #=> Integer
resp.events[0].map_iteration_started_event_details.name #=> String
resp.events[0].map_iteration_started_event_details.index #=> Integer
resp.events[0].map_iteration_succeeded_event_details.name #=> String
resp.events[0].map_iteration_succeeded_event_details.index #=> Integer
resp.events[0].map_iteration_failed_event_details.name #=> String
resp.events[0].map_iteration_failed_event_details.index #=> Integer
resp.events[0].map_iteration_aborted_event_details.name #=> String
resp.events[0].map_iteration_aborted_event_details.index #=> Integer
resp.events[0].lambda_function_failed_event_details.error #=> String
resp.events[0].lambda_function_failed_event_details.cause #=> String
resp.events[0].lambda_function_schedule_failed_event_details.error #=> String
resp.events[0].lambda_function_schedule_failed_event_details.cause #=> String
resp.events[0].lambda_function_scheduled_event_details.resource #=> String
resp.events[0].lambda_function_scheduled_event_details.input #=> String
resp.events[0].lambda_function_scheduled_event_details.input_details.truncated #=> true/false
resp.events[0].lambda_function_scheduled_event_details.timeout_in_seconds #=> Integer
resp.events[0].lambda_function_start_failed_event_details.error #=> String
resp.events[0].lambda_function_start_failed_event_details.cause #=> String
resp.events[0].lambda_function_succeeded_event_details.output #=> String
resp.events[0].lambda_function_succeeded_event_details.output_details.truncated #=> true/false
resp.events[0].lambda_function_timed_out_event_details.error #=> String
resp.events[0].lambda_function_timed_out_event_details.cause #=> String
resp.events[0].state_entered_event_details.name #=> String
resp.events[0].state_entered_event_details.input #=> String
resp.events[0].state_entered_event_details.input_details.truncated #=> true/false
resp.events[0].state_exited_event_details.name #=> String
resp.events[0].state_exited_event_details.output #=> String
resp.events[0].state_exited_event_details.output_details.truncated #=> true/false
resp.next_token #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :execution_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the execution.

          
        
      
        
          :max_results
          (Integer)
          
            
          
          
            — 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.

          
        
      
        
          :reverse_order
          (Boolean)
          
            
          
          
            — Lists events in descending order of their timeStamp.

          
        
      
        
          :next_token
          (String)
          
            
          
          
            — 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.

          
        
      
        
          :include_execution_data
          (Boolean)
          
            
          
          
            — You can select whether execution data (input or output of a history
event) is returned. The default is true.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::GetExecutionHistoryOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#events => Array<Types::HistoryEvent>
#next_token => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #list_activities(options = {})  ⇒ Types::ListActivitiesOutput 
  

  

  

  
    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.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.list_activities({
  max_results: 1,
  next_token: "PageToken",
})
    
      
        
Response structure

      
      
resp.activities #=> Array
resp.activities[0].activity_arn #=> String
resp.activities[0].name #=> String
resp.activities[0].creation_date #=> Time
resp.next_token #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :max_results
          (Integer)
          
            
          
          
            — 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.

          
        
      
        
          :next_token
          (String)
          
            
          
          
            — 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.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::ListActivitiesOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#activities => Array<Types::ActivityListItem>
#next_token => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #list_executions(options = {})  ⇒ Types::ListExecutionsOutput 
  

  

  

  
    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.
  This API action is not supported by EXPRESS state machines.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.list_executions({
  state_machine_arn: "Arn", # required
  status_filter: "RUNNING", # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED
  max_results: 1,
  next_token: "ListExecutionsPageToken",
})
    
      
        
Response structure

      
      
resp.executions #=> Array
resp.executions[0].execution_arn #=> String
resp.executions[0].state_machine_arn #=> String
resp.executions[0].name #=> String
resp.executions[0].status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "TIMED_OUT", "ABORTED"
resp.executions[0].start_date #=> Time
resp.executions[0].stop_date #=> Time
resp.next_token #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :state_machine_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the state machine whose executions is
listed.

          
        
      
        
          :status_filter
          (String)
          
            
          
          
            — If specified, only list the executions whose current execution status
matches the given filter.

          
        
      
        
          :max_results
          (Integer)
          
            
          
          
            — 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.

          
        
      
        
          :next_token
          (String)
          
            
          
          
            — 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.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::ListExecutionsOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#executions => Array<Types::ExecutionListItem>
#next_token => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #list_state_machines(options = {})  ⇒ Types::ListStateMachinesOutput 
  

  

  

  
    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.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.list_state_machines({
  max_results: 1,
  next_token: "PageToken",
})
    
      
        
Response structure

      
      
resp.state_machines #=> Array
resp.state_machines[0].state_machine_arn #=> String
resp.state_machines[0].name #=> String
resp.state_machines[0].type #=> String, one of "STANDARD", "EXPRESS"
resp.state_machines[0].creation_date #=> Time
resp.next_token #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :max_results
          (Integer)
          
            
          
          
            — 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.

          
        
      
        
          :next_token
          (String)
          
            
          
          
            — 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.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::ListStateMachinesOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#state_machines => Array<Types::StateMachineListItem>
#next_token => String



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #list_tags_for_resource(options = {})  ⇒ Types::ListTagsForResourceOutput 
  

  

  

  
    List tags for a given resource.


 
Tags may only contain Unicode letters, digits, white space, or these symbols: _ . : / = + - @.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.list_tags_for_resource({
  resource_arn: "Arn", # required
})
    
      
        
Response structure

      
      
resp.tags #=> Array
resp.tags[0].key #=> String
resp.tags[0].value #=> String
    
  

  
    
    
    Options Hash (options):
    
      
        
          :resource_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::ListTagsForResourceOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#tags => Array<Types::Tag>



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #send_task_failure(options = {})  ⇒ Struct 
  

  

  

  
    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken failed.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.send_task_failure({
  task_token: "TaskToken", # required
  error: "SensitiveError",
  cause: "SensitiveCause",
})
    
  

  
    
    
    Options Hash (options):
    
      
        
          :task_token
          (required, String)
          
            
          
          
            — 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.

          
        
      
        
          :error
          (String)
          
            
          
          
            — The error code of the failure.

          
        
      
        
          :cause
          (String)
          
            
          
          
            — A more detailed explanation of the cause of the failure.

          
        
      
    
  

Returns:

  
    
      
      
        (Struct)
      
      
      
        —
        Returns an empty response.

      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #send_task_heartbeat(options = {})  ⇒ Struct 
  

  

  

  
    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.
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.send_task_heartbeat({
  task_token: "TaskToken", # required
})
    
  

  
    
    
    Options Hash (options):
    
      
        
          :task_token
          (required, String)
          
            
          
          
            — 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.

          
        
      
    
  

Returns:

  
    
      
      
        (Struct)
      
      
      
        —
        Returns an empty response.

      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #send_task_success(options = {})  ⇒ Struct 
  

  

  

  
    Used by activity workers and task states using the callback pattern to report that the task identified by the taskToken completed successfully.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.send_task_success({
  task_token: "TaskToken", # required
  output: "SensitiveData", # required
})
    
  

  
    
    
    Options Hash (options):
    
      
        
          :task_token
          (required, String)
          
            
          
          
            — 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.

          
        
      
        
          :output
          (required, String)
          
            
          
          
            — The JSON output of the task. Length constraints apply to the payload
size, and are expressed as bytes in UTF-8 encoding.

          
        
      
    
  

Returns:

  
    
      
      
        (Struct)
      
      
      
        —
        Returns an empty response.

      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #start_execution(options = {})  ⇒ Types::StartExecutionOutput 
  

  

  

  
    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. 
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.start_execution({
  state_machine_arn: "Arn", # required
  name: "Name",
  input: "SensitiveData",
  trace_header: "TraceHeader",
})
    
      
        
Response structure

      
      
resp.execution_arn #=> String
resp.start_date #=> Time
    
  

  
    
    
    Options Hash (options):
    
      
        
          :state_machine_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the state machine to execute.

          
        
      
        
          :name
          (String)
          
            
          
          
            — 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 < > { } [ ]
wildcard characters ? *
special characters " # % \ ^ | ~ ` $ & , ; : /
control characters (U+0000-001F, U+007F-009F)



To enable logging with CloudWatch Logs, the name should only contain
0-9, A-Z, a-z, - and _.

          
        
      
        
          :input
          (String)
          
            
          
          
            — 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": "{}"

 

Length constraints apply to the payload size, and are expressed as bytes
in UTF-8 encoding.

          
        
      
        
          :trace_header
          (String)
          
            
          
          
            — Passes the AWS X-Ray trace header. The trace header can also be passed
in the request payload.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::StartExecutionOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#execution_arn => String
#start_date => Time



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #stop_execution(options = {})  ⇒ Types::StopExecutionOutput 
  

  

  

  
    Stops an execution.


 
This API action is not supported by EXPRESS state machines.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.stop_execution({
  execution_arn: "Arn", # required
  error: "SensitiveError",
  cause: "SensitiveCause",
})
    
      
        
Response structure

      
      
resp.stop_date #=> Time
    
  

  
    
    
    Options Hash (options):
    
      
        
          :execution_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the execution to stop.

          
        
      
        
          :error
          (String)
          
            
          
          
            — The error code of the failure.

          
        
      
        
          :cause
          (String)
          
            
          
          
            — A more detailed explanation of the cause of the failure.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::StopExecutionOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#stop_date => Time



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #tag_resource(options = {})  ⇒ Struct 
  

  

  

  
    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: _ . : / = + - @.



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.tag_resource({
  resource_arn: "Arn", # required
  tags: [ # required
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
})
    
  

  
    
    
    Options Hash (options):
    
      
        
          :resource_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.

          
        
      
        
          :tags
          (required, Array<Types::Tag>)
          
            
          
          
            — The list of tags to add to a resource.

Tags may only contain Unicode letters, digits, white space, or these
symbols: _ . : / = + - @.

          
        
      
    
  

Returns:

  
    
      
      
        (Struct)
      
      
      
        —
        Returns an empty response.

      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #untag_resource(options = {})  ⇒ Struct 
  

  

  

  
    Remove a tag from a Step Functions resource



  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.untag_resource({
  resource_arn: "Arn", # required
  tag_keys: ["TagKey"], # required
})
    
  

  
    
    
    Options Hash (options):
    
      
        
          :resource_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) for the Step Functions state machine or
activity.

          
        
      
        
          :tag_keys
          (required, Array<String>)
          
            
          
          
            — The list of tags to remove from the resource.

          
        
      
    
  

Returns:

  
    
      
      
        (Struct)
      
      
      
        —
        Returns an empty response.

      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #update_state_machine(options = {})  ⇒ Types::UpdateStateMachineOutput 
  

  

  

  
    Updates an existing state machine by modifying its definition, roleArn, or loggingConfiguration. 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. 
 


  


  
  
    Examples:
    
      
        
Request syntax with placeholder values

      
      
resp = client.update_state_machine({
  state_machine_arn: "Arn", # required
  definition: "Definition",
  role_arn: "Arn",
  logging_configuration: {
    level: "ALL", # accepts ALL, ERROR, FATAL, OFF
    include_execution_data: false,
    destinations: [
      {
        cloud_watch_logs_log_group: {
          log_group_arn: "Arn",
        },
      },
    ],
  },
  tracing_configuration: {
    enabled: false,
  },
})
    
      
        
Response structure

      
      
resp.update_date #=> Time
    
  

  
    
    
    Options Hash (options):
    
      
        
          :state_machine_arn
          (required, String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the state machine.

          
        
      
        
          :definition
          (String)
          
            
          
          
            — The Amazon States Language definition of the state machine. See Amazon
States Language.

          
        
      
        
          :role_arn
          (String)
          
            
          
          
            — The Amazon Resource Name (ARN) of the IAM role of the state machine.

          
        
      
        
          :logging_configuration
          (Types::LoggingConfiguration)
          
            
          
          
            — The LoggingConfiguration data type is used to set CloudWatch Logs
options.

          
        
      
        
          :tracing_configuration
          (Types::TracingConfiguration)
          
            
          
          
            — Selects whether AWS X-Ray tracing is enabled.

          
        
      
    
  

Returns:

  
    
      
      
        (Types::UpdateStateMachineOutput)
      
      
      
        —
        Returns a response object which responds to the following methods:


#update_date => Time



      
    
  


  See Also:
  
    
      AWS API Documentation
    
  



    
      
  
  
    #wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean 
  

  

  

  
    Waiters polls an API operation until a resource enters a desired
state.

Basic Usage

Waiters will poll until they are succesful, they fail by
entering a terminal state, or until a maximum number of attempts
are made.

   # polls in a loop, sleeping between attempts
   client.waiter_until(waiter_name, params)

Configuration

You can configure the maximum number of polling attempts, and the
delay (in seconds) between each polling attempt. You configure
waiters by passing a block to #wait_until:

# poll for ~25 seconds
client.wait_until(...) do |w|
  w.max_attempts = 5
  w.delay = 5
end


Callbacks

You can be notified before each polling attempt and before each
delay. If you throw :success or :failure from these callbacks,
it will terminate the waiter.

started_at = Time.now
client.wait_until(...) do |w|

  # disable max attempts
  w.max_attempts = nil

  # poll for 1 hour, instead of a number of attempts
  w.before_wait do |attempts, response|
    throw :failure if Time.now - started_at > 3600
  end

end


Handling Errors

When a waiter is successful, it returns true. When a waiter
fails, it raises an error. All errors raised extend from
Waiters::Errors::WaiterFailed.

begin
  client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
  # resource did not enter the desired state in time
end



  


  Parameters:

  
    
      
        waiter_name
      
      
        (Symbol)
      
      
      
        —
        The name of the waiter. See #waiter_names
for a full list of supported waiters.

      
    
  
    
      
        params
      
      
        (Hash)
      
      
        (defaults to: {})
      
      
        —
        Additional request parameters. See the #waiter_names
for a list of supported waiters and what request they call. The
called request determines the list of accepted parameters.

      
    
  


Yield Parameters:

  
    
      
        waiter
      
      
        (Waiters::Waiter)
      
      
      
        —
        Yields a Waiter
object that can be configured prior to waiting.

      
    
  

Returns:

  
    
      
      
        (Boolean)
      
      
      
        —
        Returns true if the waiter was successful.

      
    
  

Raises:

  
    
      
      
        (Errors::FailureStateError)
      
      
      
        —
        Raised when the waiter terminates
because the waiter has entered a state that it will not transition
out of, preventing success.

      
    
  
    
      
      
        (Errors::TooManyAttemptsError)
      
      
      
        —
        Raised when the configured
maximum number of attempts have been made, and the waiter is not
yet successful.

      
    
  
    
      
      
        (Errors::UnexpectedError)
      
      
      
        —
        Raised when an error is encounted
while polling for a resource that is not expected.

      
    
  
    
      
      
        (Errors::NoSuchWaiterError)
      
      
      
        —
        Raised when you request to wait
for an unknown state.

      
    
  




    
      
  
  
    #waiter_names  ⇒ Array<Symbol> 
  

  

  

  
    Returns the list of supported waiters. The following table lists the supported
waiters and the client method they call:



Waiter Name Client Method Default Delay: Default Max Attempts:








  


  
Returns:

  
    
      
      
        (Array<Symbol>)
      
      
      
        —
        the list of supported waiters.



      
  Generated on Fri Feb 21 17:27:42 2025 by
  yard
  0.9.34 (ruby-2.7.8).

Class: Aws::States::Client

Overview

Region

Credentials

Attribute Summary collapse

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

Constructor collapse

API Operations collapse

Instance Method Summary collapse

Methods inherited from Seahorse::Client::Base

Methods included from Seahorse::Client::HandlerBuilder

Constructor Details

#initialize(options = {}) ⇒ Aws::States::Client

Instance Method Details

#create_activity(options = {}) ⇒ Types::CreateActivityOutput

#create_state_machine(options = {}) ⇒ Types::CreateStateMachineOutput

#delete_activity(options = {}) ⇒ Struct

#delete_state_machine(options = {}) ⇒ Struct

#describe_activity(options = {}) ⇒ Types::DescribeActivityOutput

#describe_execution(options = {}) ⇒ Types::DescribeExecutionOutput

#describe_state_machine(options = {}) ⇒ Types::DescribeStateMachineOutput

#describe_state_machine_for_execution(options = {}) ⇒ Types::DescribeStateMachineForExecutionOutput

#get_activity_task(options = {}) ⇒ Types::GetActivityTaskOutput

#get_execution_history(options = {}) ⇒ Types::GetExecutionHistoryOutput

#list_activities(options = {}) ⇒ Types::ListActivitiesOutput

#list_executions(options = {}) ⇒ Types::ListExecutionsOutput

#list_state_machines(options = {}) ⇒ Types::ListStateMachinesOutput

#list_tags_for_resource(options = {}) ⇒ Types::ListTagsForResourceOutput

#send_task_failure(options = {}) ⇒ Struct

#send_task_heartbeat(options = {}) ⇒ Struct

#send_task_success(options = {}) ⇒ Struct

#start_execution(options = {}) ⇒ Types::StartExecutionOutput

#stop_execution(options = {}) ⇒ Types::StopExecutionOutput

#tag_resource(options = {}) ⇒ Struct

#untag_resource(options = {}) ⇒ Struct

#update_state_machine(options = {}) ⇒ Types::UpdateStateMachineOutput

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ Boolean

Basic Usage

Configuration

Callbacks

Handling Errors

#waiter_names ⇒ Array<Symbol>

#initialize(options = {}) ⇒ `Aws::States::Client`

#create_activity(options = {}) ⇒ `Types::CreateActivityOutput`

#create_state_machine(options = {}) ⇒ `Types::CreateStateMachineOutput`

#delete_activity(options = {}) ⇒ `Struct`

#delete_state_machine(options = {}) ⇒ `Struct`

#describe_activity(options = {}) ⇒ `Types::DescribeActivityOutput`

#describe_execution(options = {}) ⇒ `Types::DescribeExecutionOutput`

#describe_state_machine(options = {}) ⇒ `Types::DescribeStateMachineOutput`

#describe_state_machine_for_execution(options = {}) ⇒ `Types::DescribeStateMachineForExecutionOutput`

#get_activity_task(options = {}) ⇒ `Types::GetActivityTaskOutput`

#get_execution_history(options = {}) ⇒ `Types::GetExecutionHistoryOutput`

#list_activities(options = {}) ⇒ `Types::ListActivitiesOutput`

#list_executions(options = {}) ⇒ `Types::ListExecutionsOutput`

#list_state_machines(options = {}) ⇒ `Types::ListStateMachinesOutput`

#list_tags_for_resource(options = {}) ⇒ `Types::ListTagsForResourceOutput`

#send_task_failure(options = {}) ⇒ `Struct`

#send_task_heartbeat(options = {}) ⇒ `Struct`

#send_task_success(options = {}) ⇒ `Struct`

#start_execution(options = {}) ⇒ `Types::StartExecutionOutput`

#stop_execution(options = {}) ⇒ `Types::StopExecutionOutput`

#tag_resource(options = {}) ⇒ `Struct`

#untag_resource(options = {}) ⇒ `Struct`

#update_state_machine(options = {}) ⇒ `Types::UpdateStateMachineOutput`

#wait_until(waiter_name, params = {}) {|waiter| ... } ⇒ `Boolean`

#waiter_names ⇒ `Array<Symbol>`