Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.SWF.RegisterWorkflowType

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Registers a new workflow type and its configuration settings in the specified domain.

The retention period for the workflow history is set by the RegisterDomain action.

If the type already exists, then a TypeAlreadyExists fault is returned. You cannot change the configuration settings of a workflow type once it is registered and it must be registered as a new version.

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.
- defaultTaskList.name: String constraint. The key is swf:defaultTaskList.name.
- name: String constraint. The key is swf:name.
- version: String constraint. The key is swf: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

data RegisterWorkflowType Source #

See: newRegisterWorkflowType smart constructor.

Constructors

RegisterWorkflowType'

Fields

defaultLambdaRole :: Maybe Text
The default IAM role attached to this workflow type.
Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.
defaultChildPolicy :: Maybe ChildPolicy
If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The supported child policies are:
- TERMINATE – The child executions are terminated.
- REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
- ABANDON – No action is taken. The child executions continue to run.
defaultTaskList :: Maybe TaskList
If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
defaultTaskPriority :: Maybe Text
The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.
For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.
defaultExecutionStartToCloseTimeout :: Maybe Text
If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.
The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.
defaultTaskStartToCloseTimeout :: Maybe Text
If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.
The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.
description :: Maybe Text
Textual description of the workflow type.
domain :: Text
The name of the domain in which to register the workflow type.
name :: Text
The name of the workflow type.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.
version :: Text
The version of the workflow type.
The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.
The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Instances

Instances details

Eq RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods (==) :: RegisterWorkflowType -> RegisterWorkflowType -> Bool # (/=) :: RegisterWorkflowType -> RegisterWorkflowType -> Bool #
Read RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods readsPrec :: Int -> ReadS RegisterWorkflowType # readList :: ReadS [RegisterWorkflowType] # readPrec :: ReadPrec RegisterWorkflowType # readListPrec :: ReadPrec [RegisterWorkflowType] #
Show RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods showsPrec :: Int -> RegisterWorkflowType -> ShowS # show :: RegisterWorkflowType -> String # showList :: [RegisterWorkflowType] -> ShowS #
Generic RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Associated Types type Rep RegisterWorkflowType :: Type -> Type # Methods from :: RegisterWorkflowType -> Rep RegisterWorkflowType x # to :: Rep RegisterWorkflowType x -> RegisterWorkflowType #
NFData RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods rnf :: RegisterWorkflowType -> () #
Hashable RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods hashWithSalt :: Int -> RegisterWorkflowType -> Int # hash :: RegisterWorkflowType -> Int #
ToJSON RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods toJSON :: RegisterWorkflowType -> Value # toEncoding :: RegisterWorkflowType -> Encoding # toJSONList :: [RegisterWorkflowType] -> Value # toEncodingList :: [RegisterWorkflowType] -> Encoding #
AWSRequest RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Associated Types type AWSResponse RegisterWorkflowType # Methods request :: RegisterWorkflowType -> Request RegisterWorkflowType # response :: MonadResource m => Logger -> Service -> Proxy RegisterWorkflowType -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterWorkflowType))) #
ToHeaders RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods toHeaders :: RegisterWorkflowType -> [Header] #
ToPath RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods toPath :: RegisterWorkflowType -> ByteString #
ToQuery RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods toQuery :: RegisterWorkflowType -> QueryString #
type Rep RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType type Rep RegisterWorkflowType = D1 ('MetaData "RegisterWorkflowType" "Amazonka.SWF.RegisterWorkflowType" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RegisterWorkflowType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "defaultLambdaRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "defaultChildPolicy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChildPolicy))) :: (S1 ('MetaSel ('Just "defaultTaskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskList)) :: (S1 ('MetaSel ('Just "defaultTaskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "defaultExecutionStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "defaultTaskStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "domain") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))
type AWSResponse RegisterWorkflowType Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType type AWSResponse RegisterWorkflowType = RegisterWorkflowTypeResponse

newRegisterWorkflowType Source #

Arguments

:: Text	`$sel:domain:RegisterWorkflowType'`
-> Text	`$sel:name:RegisterWorkflowType'`
-> Text	`$sel:version:RegisterWorkflowType'`
-> RegisterWorkflowType

Create a value of RegisterWorkflowType with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultLambdaRole:RegisterWorkflowType', registerWorkflowType_defaultLambdaRole - The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

$sel:defaultChildPolicy:RegisterWorkflowType', registerWorkflowType_defaultChildPolicy - If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The supported child policies are:

TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.

$sel:defaultTaskList:RegisterWorkflowType', registerWorkflowType_defaultTaskList - If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

$sel:defaultTaskPriority:RegisterWorkflowType', registerWorkflowType_defaultTaskPriority - The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

$sel:defaultExecutionStartToCloseTimeout:RegisterWorkflowType', registerWorkflowType_defaultExecutionStartToCloseTimeout - If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

$sel:defaultTaskStartToCloseTimeout:RegisterWorkflowType', registerWorkflowType_defaultTaskStartToCloseTimeout - If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

$sel:description:RegisterWorkflowType', registerWorkflowType_description - Textual description of the workflow type.

$sel:domain:RegisterWorkflowType', registerWorkflowType_domain - The name of the domain in which to register the workflow type.

$sel:name:RegisterWorkflowType', registerWorkflowType_name - The name of the workflow type.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

$sel:version:RegisterWorkflowType', registerWorkflowType_version - The version of the workflow type.

The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Request Lenses

registerWorkflowType_defaultLambdaRole :: Lens' RegisterWorkflowType (Maybe Text) Source #

The default IAM role attached to this workflow type.

Executions of this workflow type need IAM roles to invoke Lambda functions. If you don't specify an IAM role when you start this workflow type, the default Lambda role is attached to the execution. For more information, see https://docs.aws.amazon.com/amazonswf/latest/developerguide/lambda-task.html in the Amazon SWF Developer Guide.

registerWorkflowType_defaultChildPolicy :: Lens' RegisterWorkflowType (Maybe ChildPolicy) Source #

If set, specifies the default policy to use for the child workflow executions when a workflow execution of this type is terminated, by calling the TerminateWorkflowExecution action explicitly or due to an expired timeout. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The supported child policies are:

TERMINATE – The child executions are terminated.
REQUEST_CANCEL – A request to cancel is attempted for each child execution by recording a WorkflowExecutionCancelRequested event in its history. It is up to the decider to take appropriate actions when it receives an execution history with this event.
ABANDON – No action is taken. The child executions continue to run.

registerWorkflowType_defaultTaskList :: Lens' RegisterWorkflowType (Maybe TaskList) Source #

If set, specifies the default task list to use for scheduling decision tasks for executions of this workflow type. This default is used only if a task list isn't provided when starting the execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

registerWorkflowType_defaultTaskPriority :: Lens' RegisterWorkflowType (Maybe Text) Source #

The default task priority to assign to the workflow type. If not assigned, then 0 is used. Valid values are integers that range from Java's Integer.MIN_VALUE (-2147483648) to Integer.MAX_VALUE (2147483647). Higher numbers indicate higher priority.

For more information about setting task priority, see Setting Task Priority in the Amazon SWF Developer Guide.

registerWorkflowType_defaultExecutionStartToCloseTimeout :: Lens' RegisterWorkflowType (Maybe Text) Source #

If set, specifies the default maximum duration for executions of this workflow type. You can override this default when starting an execution through the StartWorkflowExecution Action or StartChildWorkflowExecution Decision.

The duration is specified in seconds; an integer greater than or equal to 0. Unlike some of the other timeout parameters in Amazon SWF, you cannot specify a value of "NONE" for defaultExecutionStartToCloseTimeout; there is a one-year max limit on the time that a workflow execution can run. Exceeding this limit always causes the workflow execution to time out.

registerWorkflowType_defaultTaskStartToCloseTimeout :: Lens' RegisterWorkflowType (Maybe Text) Source #

If set, specifies the default maximum duration of decision tasks for this workflow type. This default can be overridden when starting a workflow execution using the StartWorkflowExecution action or the StartChildWorkflowExecution Decision.

The duration is specified in seconds, an integer greater than or equal to 0. You can use NONE to specify unlimited duration.

registerWorkflowType_description :: Lens' RegisterWorkflowType (Maybe Text) Source #

Textual description of the workflow type.

registerWorkflowType_domain :: Lens' RegisterWorkflowType Text Source #

The name of the domain in which to register the workflow type.

registerWorkflowType_name :: Lens' RegisterWorkflowType Text Source #

The name of the workflow type.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

registerWorkflowType_version :: Lens' RegisterWorkflowType Text Source #

The version of the workflow type.

The workflow type consists of the name and version, the combination of which must be unique within the domain. To get a list of all currently registered workflow types, use the ListWorkflowTypes action.

The specified string must not start or end with whitespace. It must not contain a : (colon), / (slash), | (vertical bar), or any control characters (\u0000-\u001f | \u007f-\u009f). Also, it must not be the literal string arn.

Destructuring the Response

data RegisterWorkflowTypeResponse Source #

See: newRegisterWorkflowTypeResponse smart constructor.

Constructors

RegisterWorkflowTypeResponse'

Instances

Instances details

Eq RegisterWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods (==) :: RegisterWorkflowTypeResponse -> RegisterWorkflowTypeResponse -> Bool # (/=) :: RegisterWorkflowTypeResponse -> RegisterWorkflowTypeResponse -> Bool #
Read RegisterWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods readsPrec :: Int -> ReadS RegisterWorkflowTypeResponse # readList :: ReadS [RegisterWorkflowTypeResponse] # readPrec :: ReadPrec RegisterWorkflowTypeResponse # readListPrec :: ReadPrec [RegisterWorkflowTypeResponse] #
Show RegisterWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods showsPrec :: Int -> RegisterWorkflowTypeResponse -> ShowS # show :: RegisterWorkflowTypeResponse -> String # showList :: [RegisterWorkflowTypeResponse] -> ShowS #
Generic RegisterWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Associated Types type Rep RegisterWorkflowTypeResponse :: Type -> Type # Methods from :: RegisterWorkflowTypeResponse -> Rep RegisterWorkflowTypeResponse x # to :: Rep RegisterWorkflowTypeResponse x -> RegisterWorkflowTypeResponse #
NFData RegisterWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType Methods rnf :: RegisterWorkflowTypeResponse -> () #
type Rep RegisterWorkflowTypeResponse Source #
Instance details Defined in Amazonka.SWF.RegisterWorkflowType type Rep RegisterWorkflowTypeResponse = D1 ('MetaData "RegisterWorkflowTypeResponse" "Amazonka.SWF.RegisterWorkflowType" "libZSservicesZSamazonka-swfZSamazonka-swf" 'False) (C1 ('MetaCons "RegisterWorkflowTypeResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newRegisterWorkflowTypeResponse :: RegisterWorkflowTypeResponse Source #

Create a value of RegisterWorkflowTypeResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.