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

Class: Aws::States::Client

Inherits:
Seahorse::Client::Base show all
Includes:
ClientStubs
Defined in:
gems/aws-sdk-states/lib/aws-sdk-states/client.rb

Instance Attribute Summary

Attributes inherited from Seahorse::Client::Base

#config, #handlers

API Operations collapse

Instance Method Summary collapse

Methods included from ClientStubs

#api_requests, #stub_data, #stub_responses

Methods inherited from Seahorse::Client::Base

add_plugin, api, clear_plugins, define, new, #operation_names, plugins, remove_plugin, set_api, set_plugins

Methods included from Seahorse::Client::HandlerBuilder

#handle, #handle_request, #handle_response

Constructor Details

#initialize(*args) ⇒ Client

Returns a new instance of Client

Parameters:

  • options (Hash)

    a customizable set of options



163
164
165
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 163

def initialize(*args)
  super
end

Instance Method Details

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

Creates an activity. An activity is a task which you write in any programming language and host on any machine which 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.

Examples:

Request syntax with placeholder values


resp = client.create_activity({
  name: "Name", # required
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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:

    • whitespace

    • brackets < > \{ \} [ ]

    • wildcard characters ? *

    • special characters " # % \ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

Returns:

See Also:



219
220
221
222
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 219

def create_activity(params = {}, options = {})
  req = build_request(:create_activity, params)
  req.send_request(options)
end

#create_state_machine(params = {}) ⇒ 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.

Examples:

Request syntax with placeholder values


resp = client.create_state_machine({
  name: "Name", # required
  definition: "Definition", # required
  role_arn: "Arn", # required
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the state machine. 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:

    • whitespace

    • brackets < > \{ \} [ ]

    • wildcard characters ? *

    • special characters " # % \ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

  • :definition (required, String)

    The Amazon States Language definition of the state machine.

  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of the IAM role to use for this state machine.

Returns:

See Also:



281
282
283
284
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 281

def create_state_machine(params = {}, options = {})
  req = build_request(:create_state_machine, params)
  req.send_request(options)
end

#delete_activity(params = {}) ⇒ Struct

Deletes an activity.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :activity_arn (required, String)

    The Amazon Resource Name (ARN) of the activity to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



303
304
305
306
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 303

def delete_activity(params = {}, options = {})
  req = build_request(:delete_activity, params)
  req.send_request(options)
end

#delete_state_machine(params = {}) ⇒ Struct

Deletes a state machine. This is an asynchronous operation: It sets the state machine's status to DELETING and begins the deletion process. Each state machine execution is deleted the next time it makes a state transition.

The state machine itself is deleted after all executions are completed or deleted.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :state_machine_arn (required, String)

    The Amazon Resource Name (ARN) of the state machine to delete.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



333
334
335
336
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 333

def delete_state_machine(params = {}, options = {})
  req = build_request(:delete_state_machine, params)
  req.send_request(options)
end

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

Describes an activity.

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :activity_arn (required, String)

    The Amazon Resource Name (ARN) of the activity to describe.

Returns:

See Also:



365
366
367
368
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 365

def describe_activity(params = {}, options = {})
  req = build_request(:describe_activity, params)
  req.send_request(options)
end

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

Describes an execution.

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.output #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :execution_arn (required, String)

    The Amazon Resource Name (ARN) of the execution to describe.

Returns:

See Also:



407
408
409
410
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 407

def describe_execution(params = {}, options = {})
  req = build_request(:describe_execution, params)
  req.send_request(options)
end

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

Describes a state machine.

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.creation_date #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :state_machine_arn (required, String)

    The Amazon Resource Name (ARN) of the state machine to describe.

Returns:

See Also:



445
446
447
448
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 445

def describe_state_machine(params = {}, options = {})
  req = build_request(:describe_state_machine, params)
  req.send_request(options)
end

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

Describes the state machine associated with a specific execution.

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :execution_arn (required, String)

    The Amazon Resource Name (ARN) of the execution you want state machine information for.

Returns:

See Also:



482
483
484
485
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 482

def describe_state_machine_for_execution(params = {}, options = {})
  req = build_request(:describe_state_machine_for_execution, params)
  req.send_request(options)
end

#get_activity_task(params = {}) ⇒ 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).

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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:

See Also:



530
531
532
533
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 530

def get_activity_task(params = {}, options = {})
  req = build_request(:get_activity_task, params)
  req.send_request(options)
end

#get_execution_history(params = {}) ⇒ 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 a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

Examples:

Request syntax with placeholder values


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

Response structure


resp.events #=> Array
resp.events[0].timestamp #=> Time
resp.events[0].type #=> String, one of "ActivityFailed", "ActivityScheduleFailed", "ActivityScheduled", "ActivityStarted", "ActivitySucceeded", "ActivityTimedOut", "ChoiceStateEntered", "ChoiceStateExited", "ExecutionFailed", "ExecutionStarted", "ExecutionSucceeded", "ExecutionAborted", "ExecutionTimedOut", "FailStateEntered", "LambdaFunctionFailed", "LambdaFunctionScheduleFailed", "LambdaFunctionScheduled", "LambdaFunctionStartFailed", "LambdaFunctionStarted", "LambdaFunctionSucceeded", "LambdaFunctionTimedOut", "SucceedStateEntered", "SucceedStateExited", "TaskStateAborted", "TaskStateEntered", "TaskStateExited", "PassStateEntered", "PassStateExited", "ParallelStateAborted", "ParallelStateEntered", "ParallelStateExited", "ParallelStateFailed", "ParallelStateStarted", "ParallelStateSucceeded", "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.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_timed_out_event_details.error #=> String
resp.events[0].activity_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.role_arn #=> String
resp.events[0].execution_succeeded_event_details.output #=> String
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].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.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_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_exited_event_details.name #=> String
resp.events[0].state_exited_event_details.output #=> String
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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 100. 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 a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

    The configured maxResults determines how many results can be returned in a single call.

Returns:

See Also:



632
633
634
635
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 632

def get_execution_history(params = {}, options = {})
  req = build_request(:get_execution_history, params)
  req.send_request(options)
end

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

Lists the existing activities.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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 100. 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 a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

    The configured maxResults determines how many results can be returned in a single call.

Returns:

See Also:



685
686
687
688
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 685

def list_activities(params = {}, options = {})
  req = build_request(:list_activities, params)
  req.send_request(options)
end

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

Lists the executions of a state machine that meet the filtering criteria.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

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: "PageToken",
})

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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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 100. 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 a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

    The configured maxResults determines how many results can be returned in a single call.

Returns:

See Also:



752
753
754
755
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 752

def list_executions(params = {}, options = {})
  req = build_request(:list_executions, params)
  req.send_request(options)
end

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

Lists the existing state machines.

If a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

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].creation_date #=> Time
resp.next_token #=> String

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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 100. 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 a nextToken is returned by a previous call, there are more results available. To retrieve the next page of results, make the call again using the returned token in nextToken. Keep all other arguments unchanged.

    The configured maxResults determines how many results can be returned in a single call.

Returns:

See Also:



805
806
807
808
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 805

def list_state_machines(params = {}, options = {})
  req = build_request(:list_state_machines, params)
  req.send_request(options)
end

#send_task_failure(params = {}) ⇒ Struct

Used by workers 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: "Error",
  cause: "Cause",
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :task_token (required, String)

    The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTask::taskToken).

  • :error (String)

    An arbitrary error code that identifies the cause of the failure.

  • :cause (String)

    A more detailed explanation of the cause of the failure.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



838
839
840
841
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 838

def send_task_failure(params = {}, options = {})
  req = build_request(:send_task_failure, params)
  req.send_request(options)
end

#send_task_heartbeat(params = {}) ⇒ Struct

Used by workers to report to the service 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. 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 event.

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.

This operation is only useful for long-lived tasks to report the liveliness of the task.

Examples:

Request syntax with placeholder values


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :task_token (required, String)

    The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken).

Returns:

  • (Struct)

    Returns an empty response.

See Also:



879
880
881
882
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 879

def send_task_heartbeat(params = {}, options = {})
  req = build_request(:send_task_heartbeat, params)
  req.send_request(options)
end

#send_task_success(params = {}) ⇒ Struct

Used by workers 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: "Data", # required
})

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :task_token (required, String)

    The token that represents this task. Task tokens are generated by the service when the tasks are assigned to a worker (see GetActivityTaskOutput$taskToken).

  • :output (required, String)

    The JSON output of the task.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



908
909
910
911
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 908

def send_task_success(params = {}, options = {})
  req = build_request(:send_task_success, params)
  req.send_request(options)
end

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

Starts a state machine execution.

Examples:

Request syntax with placeholder values


resp = client.start_execution({
  state_machine_arn: "Arn", # required
  name: "Name",
  input: "Data",
})

Response structure


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

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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 and region for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    An execution can't use the name of another execution for 90 days.

    When you make multiple StartExecution calls with the same name, the new execution doesn't run and the following rules apply:

    • When the original execution is open and the execution input from the new call is different, the ExecutionAlreadyExists message is returned.

    • When the original execution is open and the execution input from the new call is identical, the Success message is returned.

    • When the original execution is closed, the ExecutionAlreadyExists message is returned regardless of input.

    A name must not contain:

    • whitespace

    • brackets < > \{ \} [ ]

    • wildcard characters ? *

    • special characters " # % \ ^ | ~ ` $ & , ; : /

    • control characters (U+0000-001F, U+007F-009F)

  • :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": "\{\}"

Returns:

See Also:



989
990
991
992
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 989

def start_execution(params = {}, options = {})
  req = build_request(:start_execution, params)
  req.send_request(options)
end

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

Stops an execution.

Examples:

Request syntax with placeholder values


resp = client.stop_execution({
  execution_arn: "Arn", # required
  error: "Error",
  cause: "Cause",
})

Response structure


resp.stop_date #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :execution_arn (required, String)

    The Amazon Resource Name (ARN) of the execution to stop.

  • :error (String)

    An arbitrary error code that identifies the cause of the termination.

  • :cause (String)

    A more detailed explanation of the cause of the termination.

Returns:

See Also:



1025
1026
1027
1028
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1025

def stop_execution(params = {}, options = {})
  req = build_request(:stop_execution, params)
  req.send_request(options)
end

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

Updates an existing state machine by modifying its definition and/or roleArn. Running executions will continue to use the previous definition and roleArn.

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. You must include at least one of definition or roleArn or you will receive a MissingRequiredParameter error.

Examples:

Request syntax with placeholder values


resp = client.update_state_machine({
  state_machine_arn: "Arn", # required
  definition: "Definition",
  role_arn: "Arn",
})

Response structure


resp.update_date #=> Time

Parameters:

  • params (Hash) (defaults to: {})

    ({})

Options Hash (params):

  • :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.

  • :role_arn (String)

    The Amazon Resource Name (ARN) of the IAM role of the state machine.

Returns:

See Also:



1072
1073
1074
1075
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1072

def update_state_machine(params = {}, options = {})
  req = build_request(:update_state_machine, params)
  req.send_request(options)
end