Class: Aws::States::Types::ExecutionListItem

Inherits:

Struct

• Object
• Struct
• Aws::States::Types::ExecutionListItem

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-states/types.rb

Overview

Contains details about an execution.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #execution_arn ⇒ String

  The Amazon Resource Name (ARN) that identifies the execution.

• #item_count ⇒ Integer

  The total number of items processed in a child workflow execution.

• #map_run_arn ⇒ String

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

• #name ⇒ String

  The name of the execution.

• #start_date ⇒ Time

  The date the execution started.

• #state_machine_alias_arn ⇒ String

  The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

• #state_machine_arn ⇒ String

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

• #state_machine_version_arn ⇒ String

  The Amazon Resource Name (ARN) of the state machine version associated with the execution.

• #status ⇒ String

  The current status of the execution.

• #stop_date ⇒ Time

  If the execution already ended, the date the execution stopped.

Instance Attribute Details

#execution_arn ⇒ String

The Amazon Resource Name (ARN) that identifies the execution.

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#item_count ⇒ Integer

The total number of items processed in a child workflow execution. This field is returned only if ‘mapRunArn` was specified in the `ListExecutions` API action. If `stateMachineArn` was specified in `ListExecutions`, the `itemCount` field isn’t returned.

Returns:

• (Integer)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#map_run_arn ⇒ String

The Amazon Resource Name (ARN) of a Map Run. This field is returned only if ‘mapRunArn` was specified in the `ListExecutions` API action. If `stateMachineArn` was specified in `ListExecutions`, the `mapRunArn` isn’t returned.

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the execution.

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

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#start_date ⇒ Time

The date the execution started.

Returns:

• (Time)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state_machine_alias_arn ⇒ String

The Amazon Resource Name (ARN) of the state machine alias used to start an execution.

If the state machine execution was started with an unqualified ARN or a version ARN, it returns null.

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state_machine_arn ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#state_machine_version_arn ⇒ String

The Amazon Resource Name (ARN) of the state machine version associated with the execution.

If the state machine execution was started with an unqualified ARN, it returns null.

If the execution was started using a ‘stateMachineAliasArn`, both the `stateMachineAliasArn` and `stateMachineVersionArn` parameters contain the respective values.

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current status of the execution.

Returns:

• (String)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end

#stop_date ⇒ Time

If the execution already ended, the date the execution stopped.

Returns:

• (Time)

# File 'lib/aws-sdk-states/types.rb', line 1287

class ExecutionListItem < Struct.new(
  :execution_arn,
  :state_machine_arn,
  :name,
  :status,
  :start_date,
  :stop_date,
  :map_run_arn,
  :item_count,
  :state_machine_version_arn,
  :state_machine_alias_arn)
  SENSITIVE = []
  include Aws::Structure
end