Class: Aws::States::Client

Inherits:
Seahorse::Client::Base
  • Object
show all
Includes:
ClientStubs
Defined in:
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](/sdk-for-ruby/v3/developer-guide/setup-config.html).

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

Class Attribute Summary collapse

API Operations collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Client

Returns a new instance of Client.

Parameters:

  • options (Hash)

Options Hash (options):

  • :credentials (required, Aws::CredentialProvider) —

    Your AWS credentials. This can be an instance of any one of the following classes:

    • ‘Aws::Credentials` - Used for configuring static, non-refreshing credentials.

    • ‘Aws::SharedCredentials` - Used for loading static credentials from a shared file, such as `~/.aws/config`.

    • ‘Aws::AssumeRoleCredentials` - Used when you need to assume a role.

    • ‘Aws::AssumeRoleWebIdentityCredentials` - Used when you need to assume a role after providing credentials via the web.

    • ‘Aws::SSOCredentials` - Used for loading credentials from AWS SSO using an access token generated from `aws login`.

    • ‘Aws::ProcessCredentials` - Used for loading credentials from a process that outputs to stdout.

    • ‘Aws::InstanceProfileCredentials` - Used for loading credentials from an EC2 IMDS on an EC2 instance.

    • ‘Aws::ECSCredentials` - Used for loading credentials from instances running in ECS.

    • ‘Aws::CognitoIdentityCredentials` - Used for loading credentials from the Cognito Identity service.

    When ‘:credentials` are not configured directly, the following locations will be searched for credentials:

    • ‘Aws.config`

    • The ‘:access_key_id`, `:secret_access_key`, and `:session_token` options.

    • ENV, ENV

    • ‘~/.aws/credentials`

    • ‘~/.aws/config`

    • EC2/ECS IMDS instance profile - When used by default, the timeouts are very aggressive. Construct and pass an instance of ‘Aws::InstanceProfileCredentails` or `Aws::ECSCredentials` to enable retries and extended timeouts.

  • :region (required, String) —

    The AWS region to connect to. The configured ‘:region` is used to determine the service `:endpoint`. When not passed, a default `:region` is searched for in the following locations:

  • :access_key_id (String)
  • :active_endpoint_cache (Boolean) — default: false —

    When set to ‘true`, a thread polling for endpoints will be running in the background every 60 secs (default). Defaults to `false`.

  • :adaptive_retry_wait_to_fill (Boolean) — default: true —

    Used only in ‘adaptive` retry mode. When true, the request will sleep until there is sufficent client side capacity to retry the request. When false, the request will raise a `RetryCapacityNotAvailableError` and will not retry instead of sleeping.

  • :client_side_monitoring (Boolean) — default: false —

    When ‘true`, client-side metrics will be collected for all API requests from this client.

  • :client_side_monitoring_client_id (String) — default: "" —

    Allows you to provide an identifier for this client which will be attached to all generated client side metrics. Defaults to an empty string.

  • :client_side_monitoring_host (String) — default: "127.0.0.1" —

    Allows you to specify the DNS hostname or IPv4 or IPv6 address that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_port (Integer) — default: 31000 —

    Required for publishing client metrics. The port that the client side monitoring agent is running on, where client metrics will be published via UDP.

  • :client_side_monitoring_publisher (Aws::ClientSideMonitoring::Publisher) — default: Aws::ClientSideMonitoring::Publisher —

    Allows you to provide a custom client-side monitoring publisher class. By default, will use the Client Side Monitoring Agent Publisher.

  • :convert_params (Boolean) — default: true —

    When ‘true`, an attempt is made to coerce request parameters into the required types.

  • :correct_clock_skew (Boolean) — default: true —

    Used only in ‘standard` and adaptive retry modes. Specifies whether to apply a clock skew correction and retry requests with skewed client clocks.

  • :disable_host_prefix_injection (Boolean) — default: false —

    Set to true to disable SDK automatically adding host prefix to default service endpoint when available.

  • :endpoint (String) —

    The client endpoint is normally constructed from the ‘:region` option. You should only configure an `:endpoint` when connecting to test or custom endpoints. This should be a valid HTTP(S) URI.

  • :endpoint_cache_max_entries (Integer) — default: 1000 —

    Used for the maximum size limit of the LRU cache storing endpoints data for endpoint discovery enabled operations. Defaults to 1000.

  • :endpoint_cache_max_threads (Integer) — default: 10 —

    Used for the maximum threads in use for polling endpoints to be cached, defaults to 10.

  • :endpoint_cache_poll_interval (Integer) — default: 60 —

    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.

  • :endpoint_discovery (Boolean) — default: false —

    When set to ‘true`, endpoint discovery will be enabled for operations when available.

  • :log_formatter (Aws::Log::Formatter) — default: Aws::Log::Formatter.default —

    The log formatter.

  • :log_level (Symbol) — default: :info —

    The log level to send messages to the ‘:logger` at.

  • :logger (Logger) —

    The Logger instance to send log messages to. If this option is not set, logging will be disabled.

  • :max_attempts (Integer) — default: 3 —

    An integer representing the maximum number attempts that will be made for a single request, including the initial attempt. For example, setting this value to 5 will result in a request being retried up to 4 times. Used in ‘standard` and `adaptive` retry modes.

  • :profile (String) — default: "default" —

    Used when loading credentials from the shared credentials file at HOME/.aws/credentials. When not specified, ‘default’ is used.

  • :retry_backoff (Proc) —

    A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay. This option is only used in the ‘legacy` retry mode.

  • :retry_base_delay (Float) — default: 0.3 —

    The base delay in seconds used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_jitter (Symbol) — default: :none —

    A delay randomiser function used by the default backoff function. Some predefined functions can be referenced by name - :none, :equal, :full, otherwise a Proc that takes and returns a number. This option is only used in the ‘legacy` retry mode.

    @see www.awsarchitectureblog.com/2015/03/backoff.html

  • :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, auth errors, endpoint discovery, and errors from expired credentials. This option is only used in the ‘legacy` retry mode.

  • :retry_max_delay (Integer) — default: 0 —

    The maximum number of seconds to delay between retries (0 for no limit) used by the default backoff function. This option is only used in the ‘legacy` retry mode.

  • :retry_mode (String) — default: "legacy" —

    Specifies which retry algorithm to use. Values are:

    • ‘legacy` - The pre-existing retry behavior. This is default value if no retry mode is provided.

    • ‘standard` - A standardized set of retry rules across the AWS SDKs. This includes support for retry quotas, which limit the number of unsuccessful retries a client can make.

    • ‘adaptive` - An experimental retry mode that includes all the functionality of `standard` mode along with automatic client side throttling. This is a provisional mode that may change behavior in the future.

  • :secret_access_key (String)
  • :session_token (String)
  • :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.

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

  • :validate_params (Boolean) — default: true —

    When ‘true`, request parameters are validated before sending the request.

  • :http_proxy (URI::HTTP, String) —

    A proxy to send requests through. Formatted like ‘proxy.com:123’.

  • :http_open_timeout (Float) — default: 15 —

    The number of seconds to wait when opening a HTTP session before raising a ‘Timeout::Error`.

  • :http_read_timeout (Integer) — default: 60 —

    The default number of seconds to wait for response data. This value can safely be set per-request on the session.

  • :http_idle_timeout (Float) — default: 5 —

    The number of seconds a connection is allowed to sit idle before it is considered stale. Stale connections are closed and removed from the pool before making a request.

  • :http_continue_timeout (Float) — default: 1 —

    The number of seconds to wait for a 100-continue response before sending the request body. This option has no effect unless the request has “Expect” header set to “100-continue”. Defaults to ‘nil` which disables this behaviour. This value can safely be set per request on the session.

  • :http_wire_trace (Boolean) — default: false —

    When ‘true`, HTTP debug output will be sent to the `:logger`.

  • :ssl_verify_peer (Boolean) — default: true —

    When ‘true`, SSL peer certificates are verified when establishing a connection.

  • :ssl_ca_bundle (String) —

    Full path to the SSL certificate authority bundle file that should be used when verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.

  • :ssl_ca_directory (String) —

    Full path of the directory that contains the unbundled SSL certificate authority files for verifying peer certificates. If you do not pass ‘:ssl_ca_bundle` or `:ssl_ca_directory` the the system default will be used if available.



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

def initialize(*args)
  super
end

Class Attribute Details

.identifier ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1701
1702
1703
 
# File 'lib/aws-sdk-states/client.rb', line 1701

def identifier
  @identifier
end

Class Method Details

.errors_module ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



1704
1705
1706
 
# File 'lib/aws-sdk-states/client.rb', line 1704

def errors_module
  Errors
end

Instance Method Details

#build_request(operation_name, params = {}) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Parameters:

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


1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
 
# File 'lib/aws-sdk-states/client.rb', line 1679

def build_request(operation_name, params = {})
  handlers = @handlers.for(operation_name)
  context = Seahorse::Client::RequestContext.new(
    operation_name: operation_name,
    operation: config.api.operation(operation_name),
    client: self,
    params: params,
    config: config)
  context[:gem_name] = 'aws-sdk-states'
  context[:gem_version] = '1.36.0'
  Seahorse::Client::Request.new(handlers, context)
end

#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.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

<note markdown=“1”> ‘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.

</note>

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



429
430
431
432
 
# File 'lib/aws-sdk-states/client.rb', line 429

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

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

<note markdown=“1”> ‘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.

</note>

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



570
571
572
573
 
# File 'lib/aws-sdk-states/client.rb', line 570

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:



592
593
594
595
 
# File 'lib/aws-sdk-states/client.rb', line 592

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.

<note markdown=“1”> For ‘EXPRESS`state machines, the deletion will happen eventually (usually less than a minute). Running executions may emit logs after `DeleteStateMachine` API is called.

</note>

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:



622
623
624
625
 
# File 'lib/aws-sdk-states/client.rb', line 622

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.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

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:



659
660
661
662
 
# File 'lib/aws-sdk-states/client.rb', line 659

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

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

Describes an execution.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

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 #=> Boolean
resp.output #=> String
resp.output_details.included #=> Boolean
resp.trace_header #=> 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:



714
715
716
717
 
# File 'lib/aws-sdk-states/client.rb', line 714

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.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

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 #=> Boolean
resp.logging_configuration.destinations #=> Array
resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
resp.tracing_configuration.enabled #=> Boolean

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:



766
767
768
769
 
# File 'lib/aws-sdk-states/client.rb', line 766

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.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

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 #=> Boolean
resp.logging_configuration.destinations #=> Array
resp.logging_configuration.destinations[0].cloud_watch_logs_log_group.log_group_arn #=> String
resp.tracing_configuration.enabled #=> Boolean

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:



817
818
819
820
 
# File 'lib/aws-sdk-states/client.rb', line 817

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).

Polling with `GetActivityTask` can cause latency in some

implementations. See [Avoid Latency When Polling for Activity Tasks] in the Step Functions Developer Guide.

[1]: docs.aws.amazon.com/step-functions/latest/dg/bp-activity-pollers.html

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:



873
874
875
876
 
# File 'lib/aws-sdk-states/client.rb', line 873

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 ‘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.

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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 #=> Boolean
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 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:

See Also:



1034
1035
1036
1037
 
# File 'lib/aws-sdk-states/client.rb', line 1034

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 ‘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.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

See Also:



1095
1096
1097
1098
 
# File 'lib/aws-sdk-states/client.rb', line 1095

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

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

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.

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

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

See Also:



1173
1174
1175
1176
 
# File 'lib/aws-sdk-states/client.rb', line 1173

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 ‘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.

<note markdown=“1”> This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.

</note>

The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.

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

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

See Also:



1235
1236
1237
1238
 
# File 'lib/aws-sdk-states/client.rb', line 1235

def list_state_machines(params = {}, options = {})
  req = build_request(:list_state_machines, params)
  req.send_request(options)
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: ‘_ . : / = + - @`.

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

Parameters:

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

    ({})

Options Hash (params):

  • :resource_arn (required, String) —

    The Amazon Resource Name (ARN) for the Step Functions state machine or activity.

Returns:

See Also:



1269
1270
1271
1272
 
# File 'lib/aws-sdk-states/client.rb', line 1269

def list_tags_for_resource(params = {}, options = {})
  req = build_request(:list_tags_for_resource, params)
  req.send_request(options)
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.

[1]: docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

    [1]: docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html

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



1311
1312
1313
1314
 
# File 'lib/aws-sdk-states/client.rb', line 1311

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 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][1

pattern.

<note markdown=“1”> 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.

</note>

[1]: docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token [2]: docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

Returns:

  • (Struct) —

    Returns an empty response.

See Also:



1361
1362
1363
1364
 
# File 'lib/aws-sdk-states/client.rb', line 1361

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 activity workers and task states using the [callback] pattern to report that the task identified by the ‘taskToken` completed successfully.

[1]: docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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

    [1]: docs.aws.amazon.com/step-functions/latest/dg/input-output-contextobject.html

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



1401
1402
1403
1404
 
# File 'lib/aws-sdk-states/client.rb', line 1401

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.

<note markdown=“1”> ‘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.

</note>

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

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, 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 _.

    [1]: docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions

  • :input (String) —

    The string that contains the JSON input data for the execution, for example:

    ‘“input”: “: ”test“”`

    <note markdown=“1”> If you don’t include any JSON input data, you still must include the two braces, for example: ‘“input”: “{}”`

    </note>

    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:

See Also:



1485
1486
1487
1488
 
# File 'lib/aws-sdk-states/client.rb', line 1485

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

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

Parameters:

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

    ({})

Options Hash (params):

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

See Also:



1523
1524
1525
1526
 
# File 'lib/aws-sdk-states/client.rb', line 1523

def stop_execution(params = {}, options = {})
  req = build_request(:stop_execution, params)
  req.send_request(options)
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: ‘_ . : / = + - @`.

[1]: docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html [2]: docs.aws.amazon.com/IAM/latest/UserGuide/access_iam-tags.html

Examples:

Request syntax with placeholder values


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

Parameters:

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

    ({})

Options Hash (params):

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



1570
1571
1572
1573
 
# File 'lib/aws-sdk-states/client.rb', line 1570

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

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

Parameters:

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

    ({})

Options Hash (params):

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



1597
1598
1599
1600
 
# File 'lib/aws-sdk-states/client.rb', line 1597

def untag_resource(params = {}, options = {})
  req = build_request(:untag_resource, params)
  req.send_request(options)
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.

<note markdown=“1”> 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`.

</note>

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

Parameters:

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

    ({})

Options Hash (params):

Returns:

See Also:



1670
1671
1672
1673
 
# File 'lib/aws-sdk-states/client.rb', line 1670

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

#waiter_names ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


1694
1695
1696
 
# File 'lib/aws-sdk-states/client.rb', line 1694

def waiter_names
  []
end