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. Instance profile credential fetching can be disabled by setting ENV to true.

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

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

    See DefaultsModeConfiguration for a list of the accepted modes and the configuration defaults that are included.

  • :disable_host_prefix_injection (Boolean) — default: false

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

  • :disable_request_compression (Boolean) — default: false

    When set to ‘true’ the request body will not be compressed for supported operations.

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

  • :ignore_configured_endpoint_urls (Boolean)

    Setting to true disables use of endpoint URLs provided via environment variables and the shared configuration file.

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

  • :request_min_compression_size_bytes (Integer) — default: 10240

    The minimum size in bytes that triggers compression for request bodies. The value must be non-negative integer value between 0 and 10485780 bytes inclusive.

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

  • :sdk_ua_app_id (String)

    A unique and opaque application ID that is appended to the User-Agent header as app/<sdk_ua_app_id>. It should have a maximum length of 50.

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

  • :token_provider (Aws::TokenProvider)

    A Bearer Token Provider. This can be an instance of any one of the following classes:

    • ‘Aws::StaticTokenProvider` - Used for configuring static, non-refreshing tokens.

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

    When ‘:token_provider` is not configured directly, the `Aws::TokenProviderChain` will be used to search for tokens configured for your profile in shared configuration files.

  • :use_dualstack_endpoint (Boolean)

    When set to ‘true`, dualstack enabled endpoints (with `.aws` TLD) will be used if available.

  • :use_fips_endpoint (Boolean)

    When set to ‘true`, fips compatible endpoints will be used if available. When a `fips` region is used, the region is normalized and this config is set to `true`.

  • :validate_params (Boolean) — default: true

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

  • :endpoint_provider (Aws::States::EndpointProvider)

    The endpoint provider used to resolve endpoints. Any object that responds to ‘#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::States::EndpointParameters`

  • :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 (Float) — 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.

  • :ssl_timeout (Float) — default: nil

    Sets the SSL timeout in seconds.

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



395
396
397
# File 'lib/aws-sdk-states/client.rb', line 395

def initialize(*args)
  super
end

Class Attribute Details

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



3195
3196
3197
# File 'lib/aws-sdk-states/client.rb', line 3195

def identifier
  @identifier
end

Class Method Details

.errors_moduleObject

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.



3198
3199
3200
# File 'lib/aws-sdk-states/client.rb', line 3198

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: {})


3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
# File 'lib/aws-sdk-states/client.rb', line 3173

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



490
491
492
493
# File 'lib/aws-sdk-states/client.rb', line 490

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 Step Functions User Guide.

If you set the ‘publish` parameter of this API action to `true`, it publishes version `1` as the first revision of the 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>

<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`. The check is also based on the `publish` and `versionDescription` parameters. 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,
  },
  publish: false,
  version_description: "VersionDescription",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :name (required, String)

    The name of the state machine.

    A name must not contain:

    • white space

    • brackets ‘< > { } [ ]`

    • wildcard characters ‘? *`

    • special characters “ “ # % \ ^ | ~ ‘ $ & , ; : / “

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

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

  • :definition (required, String)

    The Amazon States Language definition of the state machine. See [Amazon States Language].

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

  • :role_arn (required, String)

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

  • :type (String)

    Determines whether a Standard or Express state machine is created. The default is ‘STANDARD`. You cannot update the `type` of a state machine once it has been created.

  • :logging_configuration (Types::LoggingConfiguration)

    Defines what execution history events are logged and where they are logged.

    <note markdown=“1”> By default, the ‘level` is set to `OFF`. For more information see [Log Levels] in the Step Functions User Guide.

    </note>
    

    [1]: docs.aws.amazon.com/step-functions/latest/dg/cloudwatch-log-level.html

  • :tags (Array<Types::Tag>)

    Tags to be added when creating a state machine.

    An array of key-value pairs. For more information, see [Using Cost Allocation Tags] in the *Amazon Web Services 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

  • :tracing_configuration (Types::TracingConfiguration)

    Selects whether X-Ray tracing is enabled.

  • :publish (Boolean)

    Set to ‘true` to publish the first version of the state machine during creation. The default is `false`.

  • :version_description (String)

    Sets description about the state machine version. You can only set the description if the ‘publish` parameter is set to `true`. Otherwise, if you set `versionDescription`, but `publish` to `false`, this API action throws `ValidationException`.

Returns:

See Also:



650
651
652
653
# File 'lib/aws-sdk-states/client.rb', line 650

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

#create_state_machine_alias(params = {}) ⇒ Types::CreateStateMachineAliasOutput

Creates an [alias] for a state machine that points to one or two

versions][2

of the same state machine. You can set your application

to call StartExecution with an alias and update the version the alias uses without changing the client’s code.

You can also map an alias to split StartExecution requests between two versions of a state machine. To do this, add a second ‘RoutingConfig` object in the `routingConfiguration` parameter. You must also specify the percentage of execution run requests each version should receive in both `RoutingConfig` objects. Step Functions randomly chooses which version runs a given execution based on the percentage you specify.

To create an alias that points to a single version, specify a single ‘RoutingConfig` object with a `weight` set to 100.

You can create up to 100 aliases for each state machine. You must delete unused aliases using the DeleteStateMachineAlias API action.

‘CreateStateMachineAlias` is an idempotent API. Step Functions bases the idempotency check on the `stateMachineArn`, `description`, `name`, and `routingConfiguration` parameters. Requests that contain the same values for these parameters return a successful idempotent response without creating a duplicate resource.

**Related operations:**

  • DescribeStateMachineAlias

  • ListStateMachineAliases

  • UpdateStateMachineAlias

  • DeleteStateMachineAlias

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

Examples:

Request syntax with placeholder values


resp = client.create_state_machine_alias({
  description: "AliasDescription",
  name: "CharacterRestrictedName", # required
  routing_configuration: [ # required
    {
      state_machine_version_arn: "Arn", # required
      weight: 1, # required
    },
  ],
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :description (String)

    A description for the state machine alias.

  • :name (required, String)

    The name of the state machine alias.

    To avoid conflict with version ARNs, don’t use an integer in the name of the alias.

  • :routing_configuration (required, Array<Types::RoutingConfigurationListItem>)

    The routing configuration of a state machine alias. The routing configuration shifts execution traffic between two state machine versions. ‘routingConfiguration` contains an array of `RoutingConfig` objects that specify up to two state machine versions. Step Functions then randomly choses which version to run an execution with based on the weight assigned to each `RoutingConfig`.

Returns:

See Also:



738
739
740
741
# File 'lib/aws-sdk-states/client.rb', line 738

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



760
761
762
763
# File 'lib/aws-sdk-states/client.rb', line 760

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. A state machine is deleted only when all its executions are completed. On the next state transition, the state machine’s executions are terminated.

A qualified state machine ARN can either refer to a *Distributed Map state* defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a *Distributed Map state* with a label ‘mapStateLabel` in a state machine named `myStateMachine`.

    ‘arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel`

    <note markdown=“1”> If you provide a qualified state machine ARN that refers to a *Distributed Map state*, the request fails with ‘ValidationException`.

    </note>
    
  • The following unqualified state machine ARN refers to a state machine named ‘myStateMachine`.

    ‘arn:partition:states:region:account-id:stateMachine:myStateMachine`

This API action also deletes all [versions] and [aliases] associated with a state machine.

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

</note>

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html

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:



823
824
825
826
# File 'lib/aws-sdk-states/client.rb', line 823

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

#delete_state_machine_alias(params = {}) ⇒ Struct

Deletes a state machine [alias].

After you delete a state machine alias, you can’t use it to start executions. When you delete a state machine alias, Step Functions doesn’t delete the state machine versions that alias references.

**Related operations:**

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • ListStateMachineAliases

  • UpdateStateMachineAlias

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html

Examples:

Request syntax with placeholder values


resp = client.delete_state_machine_alias({
  state_machine_alias_arn: "Arn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :state_machine_alias_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



863
864
865
866
# File 'lib/aws-sdk-states/client.rb', line 863

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

#delete_state_machine_version(params = {}) ⇒ Struct

Deletes a state machine [version]. After you delete a version, you can’t call StartExecution using that version’s ARN or use the version with a state machine [alias].

<note markdown=“1”> Deleting a state machine version won’t terminate its in-progress executions.

</note>

<note markdown=“1”> You can’t delete a state machine version currently referenced by one or more aliases. Before you delete a version, you must either delete the aliases or update them to point to another state machine version.

</note>

**Related operations:**

  • PublishStateMachineVersion

  • ListStateMachineVersions

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html

Examples:

Request syntax with placeholder values


resp = client.delete_state_machine_version({
  state_machine_version_arn: "LongArn", # required
})

Parameters:

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

    ({})

Options Hash (params):

  • :state_machine_version_arn (required, String)

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

Returns:

  • (Struct)

    Returns an empty response.

See Also:



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

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



946
947
948
949
# File 'lib/aws-sdk-states/client.rb', line 946

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

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

Provides information about a state machine execution, such as the state machine associated with the execution, the execution input and output, and relevant execution metadata. If you’ve [redriven] an execution, you can use this API action to return information about the redrives of that execution. In addition, you can use this API action to return the Map Run Amazon Resource Name (ARN) if the execution was dispatched by a Map Run.

If you specify a version or alias ARN when you call the StartExecution API action, ‘DescribeExecution` returns that ARN.

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

</note>

Executions of an ‘EXPRESS` state machine aren’t supported by ‘DescribeExecution` unless a Map Run dispatched them.

[1]: docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html

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", "PENDING_REDRIVE"
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
resp.map_run_arn #=> String
resp.error #=> String
resp.cause #=> String
resp.state_machine_version_arn #=> String
resp.state_machine_alias_arn #=> String
resp.redrive_count #=> Integer
resp.redrive_date #=> Time
resp.redrive_status #=> String, one of "REDRIVABLE", "NOT_REDRIVABLE", "REDRIVABLE_BY_MAP_RUN"
resp.redrive_status_reason #=> 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:



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

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

#describe_map_run(params = {}) ⇒ Types::DescribeMapRunOutput

Provides information about a Map Run’s configuration, progress, and results. If you’ve [redriven] a Map Run, this API action also returns information about the redrives of that Map Run. For more information, see [Examining Map Run] in the *Step Functions Developer Guide*.

[1]: docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html

Examples:

Request syntax with placeholder values


resp = client.describe_map_run({
  map_run_arn: "LongArn", # required
})

Response structure


resp.map_run_arn #=> String
resp.execution_arn #=> String
resp.status #=> String, one of "RUNNING", "SUCCEEDED", "FAILED", "ABORTED"
resp.start_date #=> Time
resp.stop_date #=> Time
resp.max_concurrency #=> Integer
resp.tolerated_failure_percentage #=> Float
resp.tolerated_failure_count #=> Integer
resp.item_counts.pending #=> Integer
resp.item_counts.running #=> Integer
resp.item_counts.succeeded #=> Integer
resp.item_counts.failed #=> Integer
resp.item_counts.timed_out #=> Integer
resp.item_counts.aborted #=> Integer
resp.item_counts.total #=> Integer
resp.item_counts.results_written #=> Integer
resp.item_counts.failures_not_redrivable #=> Integer
resp.item_counts.pending_redrive #=> Integer
resp.execution_counts.pending #=> Integer
resp.execution_counts.running #=> Integer
resp.execution_counts.succeeded #=> Integer
resp.execution_counts.failed #=> Integer
resp.execution_counts.timed_out #=> Integer
resp.execution_counts.aborted #=> Integer
resp.execution_counts.total #=> Integer
resp.execution_counts.results_written #=> Integer
resp.execution_counts.failures_not_redrivable #=> Integer
resp.execution_counts.pending_redrive #=> Integer
resp.redrive_count #=> Integer
resp.redrive_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :map_run_arn (required, String)

    The Amazon Resource Name (ARN) that identifies a Map Run.

Returns:

See Also:



1110
1111
1112
1113
# File 'lib/aws-sdk-states/client.rb', line 1110

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

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

Provides information about a state machine’s definition, its IAM role Amazon Resource Name (ARN), and configuration.

A qualified state machine ARN can either refer to a *Distributed Map state* defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a *Distributed Map state* with a label ‘mapStateLabel` in a state machine named `myStateMachine`.

    ‘arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel`

    <note markdown=“1”> If you provide a qualified state machine ARN that refers to a *Distributed Map state*, the request fails with ‘ValidationException`.

    </note>
    
  • The following qualified state machine ARN refers to an alias named ‘PROD`.

    ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>`

    <note markdown=“1”> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

    </note>
    
  • The following unqualified state machine ARN refers to a state machine named ‘myStateMachine`.

    ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>`

This API action returns the details for a state machine version if the ‘stateMachineArn` you specify is a state machine version ARN.

<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
resp.label #=> String
resp.revision_id #=> String
resp.description #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :state_machine_arn (required, String)

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

    If you specify a state machine version ARN, this API returns details about that version. The version ARN is a combination of state machine ARN and the version number separated by a colon (:). For example, ‘stateMachineARN:1`.

Returns:

See Also:



1212
1213
1214
1215
# File 'lib/aws-sdk-states/client.rb', line 1212

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

#describe_state_machine_alias(params = {}) ⇒ Types::DescribeStateMachineAliasOutput

Returns details about a state machine [alias].

**Related operations:**

  • CreateStateMachineAlias

  • ListStateMachineAliases

  • UpdateStateMachineAlias

  • DeleteStateMachineAlias

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html

Examples:

Request syntax with placeholder values


resp = client.describe_state_machine_alias({
  state_machine_alias_arn: "Arn", # required
})

Response structure


resp.state_machine_alias_arn #=> String
resp.name #=> String
resp.description #=> String
resp.routing_configuration #=> Array
resp.routing_configuration[0].state_machine_version_arn #=> String
resp.routing_configuration[0].weight #=> Integer
resp.creation_date #=> Time
resp.update_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :state_machine_alias_arn (required, String)

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

Returns:

See Also:



1266
1267
1268
1269
# File 'lib/aws-sdk-states/client.rb', line 1266

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

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

Provides information about a state machine’s definition, its execution role ARN, and configuration. If a Map Run dispatched the execution, this action returns the Map Run Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the Map Run.

<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
resp.map_run_arn #=> String
resp.label #=> String
resp.revision_id #=> String

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:



1327
1328
1329
1330
# File 'lib/aws-sdk-states/client.rb', line 1327

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.

<note markdown=“1”> This API action isn’t logged in CloudTrail.

</note>

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:



1387
1388
1389
1390
# File 'lib/aws-sdk-states/client.rb', line 1387

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", "MapRunAborted", "MapRunFailed", "MapRunStarted", "MapRunSucceeded", "ExecutionRedriven", "MapRunRedriven"
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_scheduled_event_details.task_credentials.role_arn #=> String
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]..resource_type #=> String
resp.events[0]..resource #=> String
resp.events[0]..output #=> String
resp.events[0]..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_started_event_details.state_machine_alias_arn #=> String
resp.events[0].execution_started_event_details.state_machine_version_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].execution_redriven_event_details.redrive_count #=> Integer
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_scheduled_event_details.task_credentials.role_arn #=> String
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.events[0].map_run_started_event_details.map_run_arn #=> String
resp.events[0].map_run_failed_event_details.error #=> String
resp.events[0].map_run_failed_event_details.cause #=> String
resp.events[0].map_run_redriven_event_details.map_run_arn #=> String
resp.events[0].map_run_redriven_event_details.redrive_count #=> Integer
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:



1558
1559
1560
1561
# File 'lib/aws-sdk-states/client.rb', line 1558

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:



1619
1620
1621
1622
# File 'lib/aws-sdk-states/client.rb', line 1619

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

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

Lists all executions of a state machine or a Map Run. You can list all executions related to a state machine by specifying a state machine Amazon Resource Name (ARN), or those related to a Map Run by specifying a Map Run ARN. Using this API action, you can also list all

redriven][1

executions.

You can also provide a state machine [alias] ARN or [version] ARN to list the executions associated with a specific alias or version.

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.

[1]: docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html [3]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

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",
  status_filter: "RUNNING", # accepts RUNNING, SUCCEEDED, FAILED, TIMED_OUT, ABORTED, PENDING_REDRIVE
  max_results: 1,
  next_token: "ListExecutionsPageToken",
  map_run_arn: "LongArn",
  redrive_filter: "REDRIVEN", # accepts REDRIVEN, NOT_REDRIVEN
})

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", "PENDING_REDRIVE"
resp.executions[0].start_date #=> Time
resp.executions[0].stop_date #=> Time
resp.executions[0].map_run_arn #=> String
resp.executions[0].item_count #=> Integer
resp.executions[0].state_machine_version_arn #=> String
resp.executions[0].state_machine_alias_arn #=> String
resp.executions[0].redrive_count #=> Integer
resp.executions[0].redrive_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :state_machine_arn (String)

    The Amazon Resource Name (ARN) of the state machine whose executions is listed.

    You can specify either a ‘mapRunArn` or a `stateMachineArn`, but not both.

    You can also return a list of executions associated with a specific

    alias][1

    or [version], by specifying an alias ARN or a version

    ARN in the ‘stateMachineArn` parameter.

    [1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

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

  • :map_run_arn (String)

    The Amazon Resource Name (ARN) of the Map Run that started the child workflow executions. If the ‘mapRunArn` field is specified, a list of all of the child workflow executions started by a Map Run is returned. For more information, see [Examining Map Run] in the *Step Functions Developer Guide*.

    You can specify either a ‘mapRunArn` or a `stateMachineArn`, but not both.

    [1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-examine-map-run.html

  • :redrive_filter (String)

    Sets a filter to list executions based on whether or not they have been redriven.

    For a Distributed Map, ‘redriveFilter` sets a filter to list child workflow executions based on whether or not they have been redriven.

    If you do not provide a ‘redriveFilter`, Step Functions returns a list of both redriven and non-redriven executions.

    If you provide a state machine ARN in ‘redriveFilter`, the API returns a validation exception.

Returns:

See Also:



1758
1759
1760
1761
# File 'lib/aws-sdk-states/client.rb', line 1758

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

#list_map_runs(params = {}) ⇒ Types::ListMapRunsOutput

Lists all Map Runs that were started by a given state machine execution. Use this API action to obtain Map Run ARNs, and then call ‘DescribeMapRun` to obtain more information, if needed.

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_map_runs({
  execution_arn: "Arn", # required
  max_results: 1,
  next_token: "PageToken",
})

Response structure


resp.map_runs #=> Array
resp.map_runs[0].execution_arn #=> String
resp.map_runs[0].map_run_arn #=> String
resp.map_runs[0].state_machine_arn #=> String
resp.map_runs[0].start_date #=> Time
resp.map_runs[0].stop_date #=> Time
resp.next_token #=> String

Parameters:

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

    ({})

Options Hash (params):

  • :execution_arn (required, String)

    The Amazon Resource Name (ARN) of the execution for which the Map Runs must be listed.

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



1816
1817
1818
1819
# File 'lib/aws-sdk-states/client.rb', line 1816

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

#list_state_machine_aliases(params = {}) ⇒ Types::ListStateMachineAliasesOutput

Lists [aliases] for a specified state machine ARN. Results are sorted by time, with the most recently created aliases listed first.

To list aliases that reference a state machine [version], you can specify the version ARN in the ‘stateMachineArn` parameter.

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.

**Related operations:**

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • UpdateStateMachineAlias

  • DeleteStateMachineAlias

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

Examples:

Request syntax with placeholder values


resp = client.list_state_machine_aliases({
  state_machine_arn: "Arn", # required
  next_token: "PageToken",
  max_results: 1,
})

Response structure


resp.state_machine_aliases #=> Array
resp.state_machine_aliases[0].state_machine_alias_arn #=> String
resp.state_machine_aliases[0].creation_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 for which you want to list aliases.

    If you specify a state machine version ARN, this API returns a list of aliases for that version.

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

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

Returns:

See Also:



1896
1897
1898
1899
# File 'lib/aws-sdk-states/client.rb', line 1896

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

#list_state_machine_versions(params = {}) ⇒ Types::ListStateMachineVersionsOutput

Lists [versions] for the specified state machine Amazon Resource Name (ARN).

The results are sorted in descending order of the version creation time.

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.

**Related operations:**

  • PublishStateMachineVersion

  • DeleteStateMachineVersion

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

Examples:

Request syntax with placeholder values


resp = client.list_state_machine_versions({
  state_machine_arn: "Arn", # required
  next_token: "PageToken",
  max_results: 1,
})

Response structure


resp.state_machine_versions #=> Array
resp.state_machine_versions[0].state_machine_version_arn #=> String
resp.state_machine_versions[0].creation_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.

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

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

Returns:

See Also:



1967
1968
1969
1970
# File 'lib/aws-sdk-states/client.rb', line 1967

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



2029
2030
2031
2032
# File 'lib/aws-sdk-states/client.rb', line 2029

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:



2063
2064
2065
2066
# File 'lib/aws-sdk-states/client.rb', line 2063

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

#publish_state_machine_version(params = {}) ⇒ Types::PublishStateMachineVersionOutput

Creates a [version] from the current revision of a state machine. Use versions to create immutable snapshots of your state machine. You can start executions from versions either directly or with an alias. To create an alias, use CreateStateMachineAlias.

You can publish up to 1000 versions for each state machine. You must manually delete unused versions using the DeleteStateMachineVersion API action.

‘PublishStateMachineVersion` is an idempotent API. It doesn’t create a duplicate state machine version if it already exists for the current revision. Step Functions bases ‘PublishStateMachineVersion`’s idempotency check on the ‘stateMachineArn`, `name`, and `revisionId` parameters. Requests with the same parameters return a successful idempotent response. If you don’t specify a ‘revisionId`, Step Functions checks for a previously published version of the state machine’s current revision.

**Related operations:**

  • DeleteStateMachineVersion

  • ListStateMachineVersions

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

Examples:

Request syntax with placeholder values


resp = client.publish_state_machine_version({
  state_machine_arn: "Arn", # required
  revision_id: "RevisionId",
  description: "VersionDescription",
})

Response structure


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

Parameters:

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

    ({})

Options Hash (params):

  • :state_machine_arn (required, String)

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

  • :revision_id (String)

    Only publish the state machine version if the current state machine’s revision ID matches the specified ID.

    Use this option to avoid publishing a version if the state machine changed since you last updated it. If the specified revision ID doesn’t match the state machine’s current revision ID, the API returns ‘ConflictException`.

    <note markdown=“1”> To specify an initial revision ID for a state machine with no revision ID assigned, specify the string ‘INITIAL` for the `revisionId` parameter. For example, you can specify a `revisionID` of `INITIAL` when you create a state machine using the CreateStateMachine API action.

    </note>
    
  • :description (String)

    An optional description of the state machine version.

Returns:

See Also:



2141
2142
2143
2144
# File 'lib/aws-sdk-states/client.rb', line 2141

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

#redrive_execution(params = {}) ⇒ Types::RedriveExecutionOutput

Restarts unsuccessful executions of Standard workflows that didn’t complete successfully in the last 14 days. These include failed, aborted, or timed out executions. When you [redrive] an execution, it continues the failed execution from the unsuccessful step and uses the same input. Step Functions preserves the results and execution history of the successful steps, and doesn’t rerun these steps when you redrive an execution. Redriven executions use the same state machine definition and execution ARN as the original execution attempt.

For workflows that include an [Inline Map] or [Parallel] state, ‘RedriveExecution` API action reschedules and redrives only the iterations and branches that failed or aborted.

To redrive a workflow that includes a Distributed Map state whose Map Run failed, you must redrive the [parent workflow]. The parent workflow redrives all the unsuccessful states, including a failed Map Run. If a Map Run was not started in the original execution attempt, the redriven parent workflow starts the Map Run.

<note markdown=“1”> This API action is not supported by ‘EXPRESS` state machines.

However, you can restart the unsuccessful executions of Express child

workflows in a Distributed Map by redriving its Map Run. When you redrive a Map Run, the Express child workflows are rerun using the StartExecution API action. For more information, see [Redriving Map Runs].

</note>

You can redrive executions if your original execution meets the following conditions:

  • The execution status isn’t ‘SUCCEEDED`.

  • Your workflow execution has not exceeded the redrivable period of 14 days. Redrivable period refers to the time during which you can redrive a given execution. This period starts from the day a state machine completes its execution.

  • The workflow execution has not exceeded the maximum open time of one year. For more information about state machine quotas, see [Quotas related to state machine executions].

  • The execution event history count is less than 24,999. Redriven executions append their event history to the existing event history. Make sure your workflow execution contains less than 24,999 events to accommodate the ‘ExecutionRedriven` history event and at least one other history event.

[1]: docs.aws.amazon.com/step-functions/latest/dg/redrive-executions.html [2]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html [3]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html [4]: docs.aws.amazon.com/step-functions/latest/dg/use-dist-map-orchestrate-large-scale-parallel-workloads.html#dist-map-orchestrate-parallel-workloads-key-terms [5]: docs.aws.amazon.com/step-functions/latest/dg/redrive-map-run.html [6]: docs.aws.amazon.com/step-functions/latest/dg/limits-overview.html#service-limits-state-machine-executions

Examples:

Request syntax with placeholder values


resp = client.redrive_execution({
  execution_arn: "Arn", # required
  client_token: "ClientToken",
})

Response structure


resp.redrive_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :execution_arn (required, String)

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

  • :client_token (String)

    A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If you don’t specify a client token, the Amazon Web Services SDK automatically generates a client token and uses it for the request to ensure idempotency. The API will return idempotent responses for the last 10 client tokens used to successfully redrive the execution. These client tokens are valid for up to 15 minutes after they are first used.

    **A suitable default value is auto-generated.** You should normally not need to pass this option.**

Returns:

See Also:



2239
2240
2241
2242
# File 'lib/aws-sdk-states/client.rb', line 2239

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

#send_task_failure(params = {}) ⇒ Struct

Used by activity workers, Task states using the [callback] pattern, and optionally Task states using the [job run] pattern to report that the task identified by the ‘taskToken` failed.

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



2283
2284
2285
2286
# File 'lib/aws-sdk-states/client.rb', line 2283

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, and optionally Task states using the [job run] pattern to report to Step Functions that the task represented by the specified ‘taskToken` is still making progress. 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 tasks using the [job run] or [callback] 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:



2334
2335
2336
2337
# File 'lib/aws-sdk-states/client.rb', line 2334

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

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



2375
2376
2377
2378
# File 'lib/aws-sdk-states/client.rb', line 2375

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.

A qualified state machine ARN can either refer to a *Distributed Map state* defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a *Distributed Map state* with a label ‘mapStateLabel` in a state machine named `myStateMachine`.

    ‘arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel`

    <note markdown=“1”> If you provide a qualified state machine ARN that refers to a *Distributed Map state*, the request fails with ‘ValidationException`.

    </note>
    
  • The following qualified state machine ARN refers to an alias named ‘PROD`.

    ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>`

    <note markdown=“1”> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

    </note>
    
  • The following unqualified state machine ARN refers to a state machine named ‘myStateMachine`.

    ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>`

If you start an execution with an unqualified state machine ARN, Step Functions uses the latest revision of the state machine for the execution.

To start executions of a state machine [version], call ‘StartExecution` and provide the version ARN or the ARN of an

alias][2

that points to the version.

<note markdown=“1”> ‘StartExecution` is idempotent for `STANDARD` workflows. For a `STANDARD` workflow, if you call `StartExecution` with the same name and input as a running execution, the call succeeds and return the same response as the original request. If the execution is closed or if the input is different, it returns a `400 ExecutionAlreadyExists` error. You can reuse names after 90 days.

`StartExecution` isn't idempotent for `EXPRESS` workflows.

</note>

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html [2]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html

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.

    The ‘stateMachineArn` parameter accepts one of the following inputs:

    • **An unqualified state machine ARN** – Refers to a state machine ARN that isn’t qualified with a version or alias ARN. The following is an example of an unqualified state machine ARN.

      ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>`

      Step Functions doesn’t associate state machine executions that you start with an unqualified ARN with a version. This is true even if that version uses the same revision that the execution used.

    • **A state machine version ARN** – Refers to a version ARN, which is a combination of state machine ARN and the version number separated by a colon (:). The following is an example of the ARN for version 10.

      ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>:10`

      Step Functions doesn’t associate executions that you start with a version ARN with any aliases that point to that version.

    • **A state machine alias ARN** – Refers to an alias ARN, which is a combination of state machine ARN and the alias name separated by a colon (:). The following is an example of the ARN for an alias named ‘PROD`.

      ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>`

      Step Functions associates executions that you start with an alias ARN with that alias and the state machine version used for that execution.

  • :name (String)

    Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information, see [ Limits Related to State Machine Executions] in the *Step Functions Developer Guide*.

    If you don’t provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.

    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 X-Ray trace header. The trace header can also be passed in the request payload.

Returns:

See Also:



2546
2547
2548
2549
# File 'lib/aws-sdk-states/client.rb', line 2546

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

#start_sync_execution(params = {}) ⇒ Types::StartSyncExecutionOutput

Starts a Synchronous Express state machine execution. ‘StartSyncExecution` is not available for `STANDARD` workflows.

<note markdown=“1”> ‘StartSyncExecution` will return a `200 OK` response, even if your execution fails, because the status code in the API response doesn’t reflect function errors. Error codes are reserved for errors that prevent your execution from running, such as permissions errors, limit errors, or issues with your state machine code and configuration.

</note>

<note markdown=“1”> This API action isn’t logged in CloudTrail.

</note>

Examples:

Request syntax with placeholder values


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

Response structure


resp.execution_arn #=> String
resp.state_machine_arn #=> String
resp.name #=> String
resp.start_date #=> Time
resp.stop_date #=> Time
resp.status #=> String, one of "SUCCEEDED", "FAILED", "TIMED_OUT"
resp.error #=> String
resp.cause #=> String
resp.input #=> String
resp.input_details.included #=> Boolean
resp.output #=> String
resp.output_details.included #=> Boolean
resp.trace_header #=> String
resp.billing_details.billed_memory_used_in_mb #=> Integer
resp.billing_details.billed_duration_in_milliseconds #=> Integer

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.

  • :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 X-Ray trace header. The trace header can also be passed in the request payload.

Returns:

See Also:



2638
2639
2640
2641
# File 'lib/aws-sdk-states/client.rb', line 2638

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



2676
2677
2678
2679
# File 'lib/aws-sdk-states/client.rb', line 2676

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 *Amazon Web Services 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:



2723
2724
2725
2726
# File 'lib/aws-sdk-states/client.rb', line 2723

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

#test_state(params = {}) ⇒ Types::TestStateOutput

Accepts the definition of a single state and executes it. You can test a state without creating a state machine or updating an existing state machine. Using this API, you can test the following:

  • A state’s [input and output processing] data flow

  • An [Amazon Web Services service integration] request and response

  • An [HTTP Task] request and response

You can call this API on only one state at a time. The states that you can test include the following:

  • All Task types][4

    except [Activity]

  • Pass][6
  • Wait][7
  • Choice][8
  • Succeed][9
  • Fail][10

The ‘TestState` API assumes an IAM role which must contain the required IAM permissions for the resources your state is accessing. For information about the permissions a state might need, see [IAM permissions to test a state].

The ‘TestState` API can run for up to five minutes. If the execution of a state exceeds this duration, it fails with the `States.Timeout` error.

‘TestState` doesn’t support [Activity tasks], ‘.sync` or `.waitForTaskToken` [service integration patterns],

Parallel], or [Map][14

states.

[1]: docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-input-output-dataflow [2]: docs.aws.amazon.com/step-functions/latest/dg/connect-to-services.html [3]: docs.aws.amazon.com/step-functions/latest/dg/connect-third-party-apis.html [4]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-task-state.html#task-types [5]: docs.aws.amazon.com/step-functions/latest/dg/concepts-activities.html [6]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-pass-state.html [7]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-wait-state.html [8]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-choice-state.html [9]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-succeed-state.html [10]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-fail-state.html [11]: docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions [12]: docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html [13]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-parallel-state.html [14]: docs.aws.amazon.com/step-functions/latest/dg/amazon-states-language-map-state.html

Examples:

Request syntax with placeholder values


resp = client.test_state({
  definition: "Definition", # required
  role_arn: "Arn", # required
  input: "SensitiveData",
  inspection_level: "INFO", # accepts INFO, DEBUG, TRACE
  reveal_secrets: false,
})

Response structure


resp.output #=> String
resp.error #=> String
resp.cause #=> String
resp.inspection_data.input #=> String
resp.inspection_data.after_input_path #=> String
resp.inspection_data.after_parameters #=> String
resp.inspection_data.result #=> String
resp.inspection_data.after_result_selector #=> String
resp.inspection_data.after_result_path #=> String
resp.inspection_data.request.protocol #=> String
resp.inspection_data.request.method #=> String
resp.inspection_data.request.url #=> String
resp.inspection_data.request.headers #=> String
resp.inspection_data.request.body #=> String
resp.inspection_data.response.protocol #=> String
resp.inspection_data.response.status_code #=> String
resp.inspection_data.response.status_message #=> String
resp.inspection_data.response.headers #=> String
resp.inspection_data.response.body #=> String
resp.next_state #=> String
resp.status #=> String, one of "SUCCEEDED", "FAILED", "RETRIABLE", "CAUGHT_ERROR"

Parameters:

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

    ({})

Options Hash (params):

  • :definition (required, String)
  • :role_arn (required, String)

    The Amazon Resource Name (ARN) of the execution role with the required IAM permissions for the state.

  • :input (String)

    A string that contains the JSON input data for the state.

  • :inspection_level (String)

    Determines the values to return when a state is tested. You can specify one of the following types:

    • ‘INFO`: Shows the final state output. By default, Step Functions sets `inspectionLevel` to `INFO` if you don’t specify a level.

    • ‘DEBUG`: Shows the final state output along with the input and output data processing result.

    • ‘TRACE`: Shows the HTTP request and response for an HTTP Task. This level also shows the final state output along with the input and output data processing result.

    Each of these levels also provide information about the status of the state execution and the next state to transition to.

  • :reveal_secrets (Boolean)

    Specifies whether or not to include secret information in the test result. For HTTP Tasks, a secret includes the data that an EventBridge connection adds to modify the HTTP request headers, query parameters, and body. Step Functions doesn’t omit any information included in the state definition or the HTTP response.

    If you set ‘revealSecrets` to `true`, you must make sure that the IAM user that calls the `TestState` API has permission for the `states:RevealSecrets` action. For an example of IAM policy that sets the `states:RevealSecrets` permission, see [IAM permissions to test a state]. Without this permission, Step Functions throws an access denied error.

    By default, ‘revealSecrets` is set to `false`.

    [1]: docs.aws.amazon.com/step-functions/latest/dg/test-state-isolation.html#test-state-permissions

Returns:

See Also:



2881
2882
2883
2884
# File 'lib/aws-sdk-states/client.rb', line 2881

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



2908
2909
2910
2911
# File 'lib/aws-sdk-states/client.rb', line 2908

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

#update_map_run(params = {}) ⇒ Struct

Updates an in-progress Map Run’s configuration to include changes to the settings that control maximum concurrency and Map Run failure.

Examples:

Request syntax with placeholder values


resp = client.update_map_run({
  map_run_arn: "LongArn", # required
  max_concurrency: 1,
  tolerated_failure_percentage: 1.0,
  tolerated_failure_count: 1,
})

Parameters:

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

    ({})

Options Hash (params):

  • :map_run_arn (required, String)

    The Amazon Resource Name (ARN) of a Map Run.

  • :max_concurrency (Integer)

    The maximum number of child workflow executions that can be specified to run in parallel for the Map Run at the same time.

  • :tolerated_failure_percentage (Float)

    The maximum percentage of failed items before the Map Run fails.

  • :tolerated_failure_count (Integer)

    The maximum number of failed items before the Map Run fails.

Returns:

  • (Struct)

    Returns an empty response.

See Also:



2944
2945
2946
2947
# File 'lib/aws-sdk-states/client.rb', line 2944

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

A qualified state machine ARN refers to a *Distributed Map state* defined within a state machine. For example, the qualified state machine ARN ‘arn:partition:states:region:account-id:stateMachine:stateMachineName/mapStateLabel` refers to a *Distributed Map state* with a label `mapStateLabel` in the state machine named `stateMachineName`.

A qualified state machine ARN can either refer to a *Distributed Map state* defined within a state machine, a version ARN, or an alias ARN.

The following are some examples of qualified and unqualified state machine ARNs:

  • The following qualified state machine ARN refers to a *Distributed Map state* with a label ‘mapStateLabel` in a state machine named `myStateMachine`.

    ‘arn:partition:states:region:account-id:stateMachine:myStateMachine/mapStateLabel`

    <note markdown=“1”> If you provide a qualified state machine ARN that refers to a *Distributed Map state*, the request fails with ‘ValidationException`.

    </note>
    
  • The following qualified state machine ARN refers to an alias named ‘PROD`.

    ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine:PROD>`

    <note markdown=“1”> If you provide a qualified state machine ARN that refers to a version ARN or an alias ARN, the request starts execution for that version or alias.

    </note>
    
  • The following unqualified state machine ARN refers to a state machine named ‘myStateMachine`.

    ‘arn:<partition>:states:<region>:<account-id>:stateMachine:<myStateMachine>`

After you update your state machine, you can set the ‘publish` parameter to `true` in the same action to publish a new [version]. This way, you can opt-in to strict versioning of your state machine.

<note markdown=“1”> Step Functions assigns monotonically increasing integers for state machine versions, starting at version number 1.

</note>

<note markdown=“1”> All ‘StartExecution` calls within a few seconds use the updated `definition` and `roleArn`. Executions started immediately after you call `UpdateStateMachine` may use the previous state machine `definition` and `roleArn`.

</note>

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html

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,
  },
  publish: false,
  version_description: "VersionDescription",
})

Response structure


resp.update_date #=> Time
resp.revision_id #=> String
resp.state_machine_version_arn #=> String

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. See [Amazon States Language].

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

  • :role_arn (String)

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

  • :logging_configuration (Types::LoggingConfiguration)

    Use the ‘LoggingConfiguration` data type to set CloudWatch Logs options.

  • :tracing_configuration (Types::TracingConfiguration)

    Selects whether X-Ray tracing is enabled.

  • :publish (Boolean)

    Specifies whether the state machine version is published. The default is ‘false`. To publish a version after updating the state machine, set `publish` to `true`.

  • :version_description (String)

    An optional description of the state machine version to publish.

    You can only specify the ‘versionDescription` parameter if you’ve set ‘publish` to `true`.

Returns:

See Also:



3088
3089
3090
3091
# File 'lib/aws-sdk-states/client.rb', line 3088

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

#update_state_machine_alias(params = {}) ⇒ Types::UpdateStateMachineAliasOutput

Updates the configuration of an existing state machine [alias] by modifying its ‘description` or `routingConfiguration`.

You must specify at least one of the ‘description` or `routingConfiguration` parameters to update a state machine alias.

<note markdown=“1”> ‘UpdateStateMachineAlias` is an idempotent API. Step Functions bases the idempotency check on the `stateMachineAliasArn`, `description`, and `routingConfiguration` parameters. Requests with the same parameters return an idempotent response.

</note>

<note markdown=“1”> This operation is eventually consistent. All StartExecution requests made within a few seconds use the latest alias configuration. Executions started immediately after calling ‘UpdateStateMachineAlias` may use the previous routing configuration.

</note>

**Related operations:**

  • CreateStateMachineAlias

  • DescribeStateMachineAlias

  • ListStateMachineAliases

  • DeleteStateMachineAlias

[1]: docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html

Examples:

Request syntax with placeholder values


resp = client.update_state_machine_alias({
  state_machine_alias_arn: "Arn", # required
  description: "AliasDescription",
  routing_configuration: [
    {
      state_machine_version_arn: "Arn", # required
      weight: 1, # required
    },
  ],
})

Response structure


resp.update_date #=> Time

Parameters:

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

    ({})

Options Hash (params):

  • :state_machine_alias_arn (required, String)

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

  • :description (String)

    A description of the state machine alias.

  • :routing_configuration (Array<Types::RoutingConfigurationListItem>)

    The routing configuration of the state machine alias.

    An array of ‘RoutingConfig` objects that specifies up to two state machine versions that the alias starts executions for.

Returns:

See Also:



3164
3165
3166
3167
# File 'lib/aws-sdk-states/client.rb', line 3164

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

#waiter_namesObject

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.


3188
3189
3190
# File 'lib/aws-sdk-states/client.rb', line 3188

def waiter_names
  []
end