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

Copyright(c) 2013-2016 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 .

Synopsis

Creating a Request

describeWorkflowType #

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:

  • dwtDomain - The name of the domain in which this workflow type is registered.
  • dwtWorkflowType - The workflow type to describe.

data DescribeWorkflowType #

See: describeWorkflowType smart constructor.

Instances

Eq DescribeWorkflowType # 
Data DescribeWorkflowType # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeWorkflowType -> c DescribeWorkflowType #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeWorkflowType #

toConstr :: DescribeWorkflowType -> Constr #

dataTypeOf :: DescribeWorkflowType -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkflowType) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeWorkflowType) #

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkflowType -> DescribeWorkflowType #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkflowType -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkflowType -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeWorkflowType -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeWorkflowType -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeWorkflowType -> m DescribeWorkflowType #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkflowType -> m DescribeWorkflowType #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkflowType -> m DescribeWorkflowType #

Read DescribeWorkflowType # 
Show DescribeWorkflowType # 
Generic DescribeWorkflowType # 
Hashable DescribeWorkflowType # 
ToJSON DescribeWorkflowType # 
NFData DescribeWorkflowType # 

Methods

rnf :: DescribeWorkflowType -> () #

AWSRequest DescribeWorkflowType # 
ToQuery DescribeWorkflowType # 
ToPath DescribeWorkflowType # 
ToHeaders DescribeWorkflowType # 
type Rep DescribeWorkflowType # 
type Rep DescribeWorkflowType = D1 (MetaData "DescribeWorkflowType" "Network.AWS.SWF.DescribeWorkflowType" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "DescribeWorkflowType'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dwtDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_dwtWorkflowType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowType))))
type Rs DescribeWorkflowType # 

Request Lenses

dwtDomain :: Lens' DescribeWorkflowType Text #

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

dwtWorkflowType :: Lens' DescribeWorkflowType WorkflowType #

The workflow type to describe.

Destructuring the Response

describeWorkflowTypeResponse #

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:

  • dwtrsResponseStatus - -- | The response status code.
  • dwtrsTypeInfo - 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 - Configuration settings of the workflow type registered through RegisterWorkflowType

data DescribeWorkflowTypeResponse #

Contains details about a workflow type.

See: describeWorkflowTypeResponse smart constructor.

Instances

Eq DescribeWorkflowTypeResponse # 
Data DescribeWorkflowTypeResponse # 

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> DescribeWorkflowTypeResponse -> c DescribeWorkflowTypeResponse #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c DescribeWorkflowTypeResponse #

toConstr :: DescribeWorkflowTypeResponse -> Constr #

dataTypeOf :: DescribeWorkflowTypeResponse -> DataType #

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c DescribeWorkflowTypeResponse) #

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c DescribeWorkflowTypeResponse) #

gmapT :: (forall b. Data b => b -> b) -> DescribeWorkflowTypeResponse -> DescribeWorkflowTypeResponse #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkflowTypeResponse -> r #

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> DescribeWorkflowTypeResponse -> r #

gmapQ :: (forall d. Data d => d -> u) -> DescribeWorkflowTypeResponse -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> DescribeWorkflowTypeResponse -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> DescribeWorkflowTypeResponse -> m DescribeWorkflowTypeResponse #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkflowTypeResponse -> m DescribeWorkflowTypeResponse #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> DescribeWorkflowTypeResponse -> m DescribeWorkflowTypeResponse #

Read DescribeWorkflowTypeResponse # 
Show DescribeWorkflowTypeResponse # 
Generic DescribeWorkflowTypeResponse # 
NFData DescribeWorkflowTypeResponse # 
type Rep DescribeWorkflowTypeResponse # 
type Rep DescribeWorkflowTypeResponse = D1 (MetaData "DescribeWorkflowTypeResponse" "Network.AWS.SWF.DescribeWorkflowType" "amazonka-swf-1.4.5-5efQTs2LdqG6LIeqZlvIEl" False) (C1 (MetaCons "DescribeWorkflowTypeResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_dwtrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int)) ((:*:) (S1 (MetaSel (Just Symbol "_dwtrsTypeInfo") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowTypeInfo)) (S1 (MetaSel (Just Symbol "_dwtrsConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowTypeConfiguration)))))

Response Lenses

dwtrsTypeInfo :: Lens' DescribeWorkflowTypeResponse WorkflowTypeInfo #

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 #

Configuration settings of the workflow type registered through RegisterWorkflowType