You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::States::Types::StopExecutionInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-states/lib/aws-sdk-states/types.rb

Overview

Note:

When making an API call, you may pass StopExecutionInput data as a hash:

{
  execution_arn: "Arn", # required
  error: "Error",
  cause: "Cause",
}

Instance Attribute Summary collapse

Instance Attribute Details

#causeString

A more detailed explanation of the cause of the termination.

Returns:

  • (String)


1236
1237
1238
1239
1240
1241
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1236

class StopExecutionInput < Struct.new(
  :execution_arn,
  :error,
  :cause)
  include Aws::Structure
end

#errorString

An arbitrary error code that identifies the cause of the termination.

Returns:

  • (String)


1236
1237
1238
1239
1240
1241
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1236

class StopExecutionInput < Struct.new(
  :execution_arn,
  :error,
  :cause)
  include Aws::Structure
end

#execution_arnString

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

Returns:

  • (String)


1236
1237
1238
1239
1240
1241
# File 'gems/aws-sdk-states/lib/aws-sdk-states/types.rb', line 1236

class StopExecutionInput < Struct.new(
  :execution_arn,
  :error,
  :cause)
  include Aws::Structure
end