Class: Aws::Imagebuilder::Types::WorkflowExecutionMetadata

Inherits:

Struct

• Object
• Struct
• Aws::Imagebuilder::Types::WorkflowExecutionMetadata

Defined in:

gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb

Overview

Metadata that includes details and status from this runtime instance of the workflow.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #end_time ⇒ String

  The timestamp when this runtime instance of the workflow finished.

• #message ⇒ String

  The runtime output message from the workflow, if applicable.

• #start_time ⇒ String

  The timestamp when the runtime instance of this workflow started.

• #status ⇒ String

  The current runtime status for this workflow.

• #total_step_count ⇒ Integer

  The total number of steps in the workflow.

• #total_steps_failed ⇒ Integer

  A runtime count for the number of steps in the workflow that failed.

• #total_steps_skipped ⇒ Integer

  A runtime count for the number of steps in the workflow that were skipped.

• #total_steps_succeeded ⇒ Integer

  A runtime count for the number of steps in the workflow that ran successfully.

• #type ⇒ String

  Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

• #workflow_build_version_arn ⇒ String

  The Amazon Resource Name (ARN) of the workflow resource build version that ran.

• #workflow_execution_id ⇒ String

  Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

Instance Attribute Details

#end_time ⇒ String

The timestamp when this runtime instance of the workflow finished.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#message ⇒ String

The runtime output message from the workflow, if applicable.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#start_time ⇒ String

The timestamp when the runtime instance of this workflow started.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The current runtime status for this workflow.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#total_step_count ⇒ Integer

The total number of steps in the workflow. This should equal the sum of the step counts for steps that succeeded, were skipped, and failed.

Returns:

• (Integer)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#total_steps_failed ⇒ Integer

A runtime count for the number of steps in the workflow that failed.

Returns:

• (Integer)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#total_steps_skipped ⇒ Integer

A runtime count for the number of steps in the workflow that were skipped.

Returns:

• (Integer)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#total_steps_succeeded ⇒ Integer

A runtime count for the number of steps in the workflow that ran successfully.

Returns:

• (Integer)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#type ⇒ String

Indicates what type of workflow that Image Builder ran for this runtime instance of the workflow.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_build_version_arn ⇒ String

The Amazon Resource Name (ARN) of the workflow resource build version that ran.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_execution_id ⇒ String

Unique identifier that Image Builder assigns to keep track of runtime resources each time it runs a workflow.

Returns:

• (String)

# File 'gems/aws-sdk-imagebuilder/lib/aws-sdk-imagebuilder/types.rb', line 7631

class WorkflowExecutionMetadata < Struct.new(
  :workflow_build_version_arn,
  :workflow_execution_id,
  :type,
  :status,
  :message,
  :total_step_count,
  :total_steps_succeeded,
  :total_steps_failed,
  :total_steps_skipped,
  :start_time,
  :end_time)
  SENSITIVE = []
  include Aws::Structure
end