Class: Aws::SWF::Types::RequestCancelExternalWorkflowExecutionDecisionAttributes

Inherits:
Struct
  • Object
show all
Includes:
Aws::Structure
Defined in:
lib/aws-sdk-swf/types.rb

Overview

Note:

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

{
  workflow_id: "WorkflowId", # required
  run_id: "WorkflowRunIdOptional",
  control: "Data",
}

Provides the details of the ‘RequestCancelExternalWorkflowExecution` decision.

**Access Control**

You can use IAM policies to control this decision’s access to Amazon SWF resources as follows:

  • Use a ‘Resource` element with the domain name to limit the action to only specified domains.

  • Use an ‘Action` element to allow or deny permission to call this action.

  • You cannot use an IAM policy to constrain this action’s parameters.

If the caller doesn’t have sufficient permissions to invoke the action, or the parameter values fall outside the specified constraints, the action fails. The associated event attribute’s ‘cause` parameter is set to `OPERATION_NOT_PERMITTED`. For details and example IAM policies, see [Using IAM to Manage Access to Amazon SWF Workflows] in the *Amazon SWF Developer Guide*.

[1]: docs.aws.amazon.com/amazonswf/latest/developerguide/swf-dev-iam.html

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#control ⇒ String

The data attached to the event that can be used by the decider in subsequent workflow tasks.

Returns:

  • (String) 


4443
4444
4445
4446
4447
4448
4449
 
# File 'lib/aws-sdk-swf/types.rb', line 4443

class RequestCancelExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :control)
  SENSITIVE = []
  include Aws::Structure
end

#run_id ⇒ String

The ‘runId` of the external workflow execution to cancel.

Returns:

  • (String) 


4443
4444
4445
4446
4447
4448
4449
 
# File 'lib/aws-sdk-swf/types.rb', line 4443

class RequestCancelExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :control)
  SENSITIVE = []
  include Aws::Structure
end

#workflow_id ⇒ String

The ‘workflowId` of the external workflow execution to cancel.

Returns:

  • (String) 


4443
4444
4445
4446
4447
4448
4449
 
# File 'lib/aws-sdk-swf/types.rb', line 4443

class RequestCancelExternalWorkflowExecutionDecisionAttributes < Struct.new(
  :workflow_id,
  :run_id,
  :control)
  SENSITIVE = []
  include Aws::Structure
end