amazonka-swf-1.3.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.DescribeWorkflowType

Contents

Description

Returns information about the specified workflow type. This includes configuration settings specified when the type was registered and other information such as creation date, current status, and so on.

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 DescribeWorkflowType.

Synopsis

Creating a Request

describeWorkflowType Source

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

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

Request Lenses

dwtDomain :: Lens' DescribeWorkflowType Text Source

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

Destructuring the Response

describeWorkflowTypeResponse Source

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

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

Response Lenses

dwtrsTypeInfo :: Lens' DescribeWorkflowTypeResponse WorkflowTypeInfo Source

General information about the workflow type.

The status of the workflow type (returned in the WorkflowTypeInfo structure) can be one of the following.

  • REGISTERED: The type is registered and available. Workers supporting this type should be running.
  • DEPRECATED: The type was deprecated using DeprecateWorkflowType, but is still in use. You should keep workers supporting this type running. You cannot create new workflow executions of this type.

dwtrsConfiguration :: Lens' DescribeWorkflowTypeResponse WorkflowTypeConfiguration Source

Configuration settings of the workflow type registered through RegisterWorkflowType