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

Copyright(c) 2013-2018 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@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 continues to run. A deprecated workflow type may still be used when calling visibility actions.

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

Synopsis

Creating a Request

deprecateWorkflowType #

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:

  • dDomain - The name of the domain in which the workflow type is registered.
  • dWorkflowType - The workflow type to deprecate.

data DeprecateWorkflowType #

See: deprecateWorkflowType smart constructor.

Instances
Eq DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Data DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Methods

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

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

toConstr :: DeprecateWorkflowType -> Constr #

dataTypeOf :: DeprecateWorkflowType -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Show DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Generic DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Associated Types

type Rep DeprecateWorkflowType :: * -> * #

Hashable DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

ToJSON DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

AWSRequest DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Associated Types

type Rs DeprecateWorkflowType :: * #

ToHeaders DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

ToPath DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

ToQuery DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

NFData DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Methods

rnf :: DeprecateWorkflowType -> () #

type Rep DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

type Rep DeprecateWorkflowType = D1 (MetaData "DeprecateWorkflowType" "Network.AWS.SWF.DeprecateWorkflowType" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "DeprecateWorkflowType'" PrefixI True) (S1 (MetaSel (Just "_dDomain") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text) :*: S1 (MetaSel (Just "_dWorkflowType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 WorkflowType)))
type Rs DeprecateWorkflowType # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Request Lenses

dDomain :: Lens' DeprecateWorkflowType Text #

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

dWorkflowType :: Lens' DeprecateWorkflowType WorkflowType #

The workflow type to deprecate.

Destructuring the Response

deprecateWorkflowTypeResponse :: DeprecateWorkflowTypeResponse #

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

data DeprecateWorkflowTypeResponse #

See: deprecateWorkflowTypeResponse smart constructor.

Instances
Eq DeprecateWorkflowTypeResponse # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Data DeprecateWorkflowTypeResponse # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Methods

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

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

toConstr :: DeprecateWorkflowTypeResponse -> Constr #

dataTypeOf :: DeprecateWorkflowTypeResponse -> DataType #

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

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

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

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

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

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

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

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

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

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

Read DeprecateWorkflowTypeResponse # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Show DeprecateWorkflowTypeResponse # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Generic DeprecateWorkflowTypeResponse # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

Associated Types

type Rep DeprecateWorkflowTypeResponse :: * -> * #

NFData DeprecateWorkflowTypeResponse # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

type Rep DeprecateWorkflowTypeResponse # 
Instance details

Defined in Network.AWS.SWF.DeprecateWorkflowType

type Rep DeprecateWorkflowTypeResponse = D1 (MetaData "DeprecateWorkflowTypeResponse" "Network.AWS.SWF.DeprecateWorkflowType" "amazonka-swf-1.6.0-1h41zhaEbfa3Fk0SeWaXFv" False) (C1 (MetaCons "DeprecateWorkflowTypeResponse'" PrefixI False) (U1 :: * -> *))