AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RequestCancelExternalWorkflowExecutionDecisionAttributes as input to an Aws::Client method, you can use a vanilla 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.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#controlString

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

Returns:

  • (String)

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

#run_idString

The runId of the external workflow execution to cancel.

Returns:

  • (String)

    The runId of the external workflow execution to cancel.

#workflow_idString

The workflowId of the external workflow execution to cancel.

Returns:

  • (String)

    The workflowId of the external workflow execution to cancel.