amazonka-swf-1.2.0.1: Amazon Simple Workflow Service SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.SWF.DeprecateWorkflowType

Contents

Description

Deprecates the specified workflow type. After a workflow type has been deprecated, you cannot create new executions of that type. Executions that were started before the type was deprecated will continue to run. A deprecated workflow type may still be used when calling visibility actions.

This operation is eventually consistent. The results are best effort and may not exactly reflect recent updates and changes.

Access Control

You can use IAM policies to control this action'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.
  • Constrain the following parameters by using a Condition element with the appropriate keys.
  • 'workflowType.name': String constraint. The key is 'swf:workflowType.name'.
  • 'workflowType.version': String constraint. The key is 'swf:workflowType.version'.

If the caller does not 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 will be set to OPERATION_NOT_PERMITTED. For details and example IAM policies, see Using IAM to Manage Access to Amazon SWF Workflows.

See: AWS API Reference for DeprecateWorkflowType.

Synopsis

Creating a Request

deprecateWorkflowType Source

Creates a value of DeprecateWorkflowType with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

Request Lenses

dDomain :: Lens' DeprecateWorkflowType Text Source

The name of the domain in which the workflow type is registered.

dWorkflowType :: Lens' DeprecateWorkflowType WorkflowType Source

The workflow type to deprecate.

Destructuring the Response

deprecateWorkflowTypeResponse :: DeprecateWorkflowTypeResponse Source

Creates a value of DeprecateWorkflowTypeResponse with the minimum fields required to make a request.