Class: Aws::States::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::States::Client
- Includes:
- ClientStubs
- Defined in:
- gems/aws-sdk-states/lib/aws-sdk-states/client.rb
Overview
An API client for States. To construct a client, you need to configure a :region
and :credentials
.
client = Aws::States::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the developer guide.
See #initialize for a full list of supported configuration options.
Instance Attribute Summary
Attributes inherited from Seahorse::Client::Base
API Operations collapse
-
#create_activity(params = {}) ⇒ Types::CreateActivityOutput
Creates an activity.
-
#create_state_machine(params = {}) ⇒ Types::CreateStateMachineOutput
Creates a state machine.
-
#delete_activity(params = {}) ⇒ Struct
Deletes an activity.
-
#delete_state_machine(params = {}) ⇒ Struct
Deletes a state machine.
-
#describe_activity(params = {}) ⇒ Types::DescribeActivityOutput
Describes an activity.
-
#describe_execution(params = {}) ⇒ Types::DescribeExecutionOutput
Describes an execution.
-
#describe_state_machine(params = {}) ⇒ Types::DescribeStateMachineOutput
Describes a state machine.
-
#describe_state_machine_for_execution(params = {}) ⇒ Types::DescribeStateMachineForExecutionOutput
Describes the state machine associated with a specific execution.
-
#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.
-
#get_execution_history(params = {}) ⇒ Types::GetExecutionHistoryOutput
Returns the history of the specified execution as a list of events.
-
#list_activities(params = {}) ⇒ Types::ListActivitiesOutput
Lists the existing activities.
-
#list_executions(params = {}) ⇒ Types::ListExecutionsOutput
Lists the executions of a state machine that meet the filtering criteria.
-
#list_state_machines(params = {}) ⇒ Types::ListStateMachinesOutput
Lists the existing state machines.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List tags for a given resource.
-
#send_task_failure(params = {}) ⇒ Struct
Used by activity workers and task states using the [callback][1] pattern to report that the task identified by the
taskToken
failed. -
#send_task_heartbeat(params = {}) ⇒ Struct
Used by activity workers and task states using the [callback][1] pattern to report to Step Functions that the task represented by the specified
taskToken
is still making progress. -
#send_task_success(params = {}) ⇒ Struct
Used by activity workers and task states using the [callback][1] pattern to report that the task identified by the
taskToken
completed successfully. -
#start_execution(params = {}) ⇒ Types::StartExecutionOutput
Starts a state machine execution.
-
#start_sync_execution(params = {}) ⇒ Types::StartSyncExecutionOutput
Starts a Synchronous Express state machine execution.
-
#stop_execution(params = {}) ⇒ Types::StopExecutionOutput
Stops an execution.
-
#tag_resource(params = {}) ⇒ Struct
Add a tag to a Step Functions resource.
-
#untag_resource(params = {}) ⇒ Struct
Remove a tag from a Step Functions resource.
-
#update_state_machine(params = {}) ⇒ Types::UpdateStateMachineOutput
Updates an existing state machine by modifying its
definition
,roleArn
, orloggingConfiguration
.
Instance Method Summary collapse
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
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(options) ⇒ Client
Returns a new instance of Client.
358 359 360 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 358 def initialize(*args) super end |
Instance Method Details
#create_activity(params = {}) ⇒ 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.
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.
453 454 455 456 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 453 def create_activity(params = {}, = {}) req = build_request(:create_activity, params) req.send_request() 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. For more information, see Amazon
States Language in the AWS Step Functions User Guide.
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.
594 595 596 597 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 594 def create_state_machine(params = {}, = {}) req = build_request(:create_state_machine, params) req.send_request() end |
#delete_activity(params = {}) ⇒ Struct
Deletes an activity.
616 617 618 619 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 616 def delete_activity(params = {}, = {}) req = build_request(:delete_activity, params) req.send_request() 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.
EXPRESS
state machines, the deletion will happen eventually
(usually less than a minute). Running executions may emit logs after
DeleteStateMachine
API is called.
646 647 648 649 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 646 def delete_state_machine(params = {}, = {}) req = build_request(:delete_state_machine, params) req.send_request() end |
#describe_activity(params = {}) ⇒ Types::DescribeActivityOutput
Describes an activity.
683 684 685 686 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 683 def describe_activity(params = {}, = {}) req = build_request(:describe_activity, params) req.send_request() end |
#describe_execution(params = {}) ⇒ Types::DescribeExecutionOutput
Describes an execution.
This API action is not supported by EXPRESS
state machines.
738 739 740 741 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 738 def describe_execution(params = {}, = {}) req = build_request(:describe_execution, params) req.send_request() end |
#describe_state_machine(params = {}) ⇒ Types::DescribeStateMachineOutput
Describes a state machine.
790 791 792 793 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 790 def describe_state_machine(params = {}, = {}) req = build_request(:describe_state_machine, params) req.send_request() end |
#describe_state_machine_for_execution(params = {}) ⇒ Types::DescribeStateMachineForExecutionOutput
Describes the state machine associated with a specific execution.
This API action is not supported by EXPRESS
state machines.
841 842 843 844 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 841 def describe_state_machine_for_execution(params = {}, = {}) req = build_request(:describe_state_machine_for_execution, params) req.send_request() 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).
Polling with GetActivityTask
can cause latency in some
implementations. See Avoid Latency When Polling for Activity
Tasks in the Step Functions Developer Guide.
897 898 899 900 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 897 def get_activity_task(params = {}, = {}) req = build_request(:get_activity_task, params) req.send_request() 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 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1058 1059 1060 1061 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1058 def get_execution_history(params = {}, = {}) req = build_request(:get_execution_history, params) req.send_request() end |
#list_activities(params = {}) ⇒ 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1119 1120 1121 1122 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1119 def list_activities(params = {}, = {}) req = build_request(:list_activities, params) req.send_request() end |
#list_executions(params = {}) ⇒ 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 API action is not supported by EXPRESS
state machines.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1197 1198 1199 1200 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1197 def list_executions(params = {}, = {}) req = build_request(:list_executions, params) req.send_request() end |
#list_state_machines(params = {}) ⇒ 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.
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
1259 1260 1261 1262 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1259 def list_state_machines(params = {}, = {}) req = build_request(:list_state_machines, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceOutput
List tags for a given resource.
Tags may only contain Unicode letters, digits, white space, or these
symbols: _ . : / = + - @
.
1293 1294 1295 1296 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1293 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#send_task_failure(params = {}) ⇒ Struct
Used by activity workers and task states using the callback
pattern to report that the task identified by the taskToken
failed.
1335 1336 1337 1338 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1335 def send_task_failure(params = {}, = {}) req = build_request(:send_task_failure, params) req.send_request() end |
#send_task_heartbeat(params = {}) ⇒ 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.
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.
1385 1386 1387 1388 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1385 def send_task_heartbeat(params = {}, = {}) req = build_request(:send_task_heartbeat, params) req.send_request() end |
#send_task_success(params = {}) ⇒ Struct
Used by activity workers and task states using the callback
pattern to report that the task identified by the taskToken
completed successfully.
1425 1426 1427 1428 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1425 def send_task_success(params = {}, = {}) req = build_request(:send_task_success, params) req.send_request() end |
#start_execution(params = {}) ⇒ 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.
1509 1510 1511 1512 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1509 def start_execution(params = {}, = {}) req = build_request(:start_execution, params) req.send_request() end |
#start_sync_execution(params = {}) ⇒ Types::StartSyncExecutionOutput
Starts a Synchronous Express state machine execution.
1588 1589 1590 1591 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1588 def start_sync_execution(params = {}, = {}) req = build_request(:start_sync_execution, params) req.send_request() end |
#stop_execution(params = {}) ⇒ Types::StopExecutionOutput
Stops an execution.
This API action is not supported by EXPRESS
state machines.
1626 1627 1628 1629 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1626 def stop_execution(params = {}, = {}) req = build_request(:stop_execution, params) req.send_request() end |
#tag_resource(params = {}) ⇒ 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: _ . : / = + - @
.
1673 1674 1675 1676 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1673 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Remove a tag from a Step Functions resource
1700 1701 1702 1703 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1700 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_state_machine(params = {}) ⇒ 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.
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
.
1773 1774 1775 1776 |
# File 'gems/aws-sdk-states/lib/aws-sdk-states/client.rb', line 1773 def update_state_machine(params = {}, = {}) req = build_request(:update_state_machine, params) req.send_request() end |