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.RegisterActivityType
Description
Registers a new activity type along with its configuration settings in the specified domain.
A TypeAlreadyExists
fault is returned if the type already exists in
the domain. You cannot change any configuration settings of the type
after its registration, 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 isswf:defaultTaskList.name
.name
: String constraint. The key isswf:name
.version
: String constraint. The key isswf: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
- data RegisterActivityType = RegisterActivityType' {
- defaultTaskScheduleToStartTimeout :: Maybe Text
- defaultTaskList :: Maybe TaskList
- defaultTaskPriority :: Maybe Text
- defaultTaskHeartbeatTimeout :: Maybe Text
- defaultTaskScheduleToCloseTimeout :: Maybe Text
- defaultTaskStartToCloseTimeout :: Maybe Text
- description :: Maybe Text
- domain :: Text
- name :: Text
- version :: Text
- newRegisterActivityType :: Text -> Text -> Text -> RegisterActivityType
- registerActivityType_defaultTaskScheduleToStartTimeout :: Lens' RegisterActivityType (Maybe Text)
- registerActivityType_defaultTaskList :: Lens' RegisterActivityType (Maybe TaskList)
- registerActivityType_defaultTaskPriority :: Lens' RegisterActivityType (Maybe Text)
- registerActivityType_defaultTaskHeartbeatTimeout :: Lens' RegisterActivityType (Maybe Text)
- registerActivityType_defaultTaskScheduleToCloseTimeout :: Lens' RegisterActivityType (Maybe Text)
- registerActivityType_defaultTaskStartToCloseTimeout :: Lens' RegisterActivityType (Maybe Text)
- registerActivityType_description :: Lens' RegisterActivityType (Maybe Text)
- registerActivityType_domain :: Lens' RegisterActivityType Text
- registerActivityType_name :: Lens' RegisterActivityType Text
- registerActivityType_version :: Lens' RegisterActivityType Text
- data RegisterActivityTypeResponse = RegisterActivityTypeResponse' {
- newRegisterActivityTypeResponse :: RegisterActivityTypeResponse
Creating a Request
data RegisterActivityType Source #
See: newRegisterActivityType
smart constructor.
Constructors
RegisterActivityType' | |
Fields
|
Instances
newRegisterActivityType Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> RegisterActivityType |
Create a value of RegisterActivityType
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:defaultTaskScheduleToStartTimeout:RegisterActivityType'
, registerActivityType_defaultTaskScheduleToStartTimeout
- If set, specifies the default maximum duration that a task of this
activity type can wait before being assigned to a worker. This default
can be overridden when scheduling an activity task using the
ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal
to 0
. You can use NONE
to specify unlimited duration.
$sel:defaultTaskList:RegisterActivityType'
, registerActivityType_defaultTaskList
- If set, specifies the default task list to use for scheduling tasks of
this activity type. This default task list is used if a task list isn't
provided when a task is scheduled through the ScheduleActivityTask
Decision.
$sel:defaultTaskPriority:RegisterActivityType'
, registerActivityType_defaultTaskPriority
- The default task priority to assign to the activity 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 in the Amazon SWF Developer Guide..
$sel:defaultTaskHeartbeatTimeout:RegisterActivityType'
, registerActivityType_defaultTaskHeartbeatTimeout
- If set, specifies the default maximum time before which a worker
processing a task of this type must report progress by calling
RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity
task is automatically timed out. This default can be overridden when
scheduling an activity task using the ScheduleActivityTask
Decision.
If the activity worker subsequently attempts to record a heartbeat or
returns a result, the activity worker receives an UnknownResource
fault. In this case, Amazon SWF no longer considers the activity task to
be valid; the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal
to 0
. You can use NONE
to specify unlimited duration.
$sel:defaultTaskScheduleToCloseTimeout:RegisterActivityType'
, registerActivityType_defaultTaskScheduleToCloseTimeout
- If set, specifies the default maximum duration for a task of this
activity type. This default can be overridden when scheduling an
activity task using the ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal
to 0
. You can use NONE
to specify unlimited duration.
$sel:defaultTaskStartToCloseTimeout:RegisterActivityType'
, registerActivityType_defaultTaskStartToCloseTimeout
- If set, specifies the default maximum duration that a worker can take to
process tasks of this activity type. This default can be overridden when
scheduling an activity task using the ScheduleActivityTask
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:RegisterActivityType'
, registerActivityType_description
- A textual description of the activity type.
$sel:domain:RegisterActivityType'
, registerActivityType_domain
- The name of the domain in which this activity is to be registered.
$sel:name:RegisterActivityType'
, registerActivityType_name
- The name of the activity type within the domain.
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:RegisterActivityType'
, registerActivityType_version
- The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique within the domain.
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
registerActivityType_defaultTaskScheduleToStartTimeout :: Lens' RegisterActivityType (Maybe Text) Source #
If set, specifies the default maximum duration that a task of this
activity type can wait before being assigned to a worker. This default
can be overridden when scheduling an activity task using the
ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal
to 0
. You can use NONE
to specify unlimited duration.
registerActivityType_defaultTaskList :: Lens' RegisterActivityType (Maybe TaskList) Source #
If set, specifies the default task list to use for scheduling tasks of
this activity type. This default task list is used if a task list isn't
provided when a task is scheduled through the ScheduleActivityTask
Decision.
registerActivityType_defaultTaskPriority :: Lens' RegisterActivityType (Maybe Text) Source #
The default task priority to assign to the activity 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 in the Amazon SWF Developer Guide..
registerActivityType_defaultTaskHeartbeatTimeout :: Lens' RegisterActivityType (Maybe Text) Source #
If set, specifies the default maximum time before which a worker
processing a task of this type must report progress by calling
RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity
task is automatically timed out. This default can be overridden when
scheduling an activity task using the ScheduleActivityTask
Decision.
If the activity worker subsequently attempts to record a heartbeat or
returns a result, the activity worker receives an UnknownResource
fault. In this case, Amazon SWF no longer considers the activity task to
be valid; the activity worker should clean up the activity task.
The duration is specified in seconds, an integer greater than or equal
to 0
. You can use NONE
to specify unlimited duration.
registerActivityType_defaultTaskScheduleToCloseTimeout :: Lens' RegisterActivityType (Maybe Text) Source #
If set, specifies the default maximum duration for a task of this
activity type. This default can be overridden when scheduling an
activity task using the ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal
to 0
. You can use NONE
to specify unlimited duration.
registerActivityType_defaultTaskStartToCloseTimeout :: Lens' RegisterActivityType (Maybe Text) Source #
If set, specifies the default maximum duration that a worker can take to
process tasks of this activity type. This default can be overridden when
scheduling an activity task using the ScheduleActivityTask
Decision.
The duration is specified in seconds, an integer greater than or equal
to 0
. You can use NONE
to specify unlimited duration.
registerActivityType_description :: Lens' RegisterActivityType (Maybe Text) Source #
A textual description of the activity type.
registerActivityType_domain :: Lens' RegisterActivityType Text Source #
The name of the domain in which this activity is to be registered.
registerActivityType_name :: Lens' RegisterActivityType Text Source #
The name of the activity type within the domain.
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
.
registerActivityType_version :: Lens' RegisterActivityType Text Source #
The version of the activity type.
The activity type consists of the name and version, the combination of which must be unique within the domain.
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 RegisterActivityTypeResponse Source #
See: newRegisterActivityTypeResponse
smart constructor.
Constructors
RegisterActivityTypeResponse' | |
Instances
Eq RegisterActivityTypeResponse Source # | |
Defined in Amazonka.SWF.RegisterActivityType Methods (==) :: RegisterActivityTypeResponse -> RegisterActivityTypeResponse -> Bool # (/=) :: RegisterActivityTypeResponse -> RegisterActivityTypeResponse -> Bool # | |
Read RegisterActivityTypeResponse Source # | |
Show RegisterActivityTypeResponse Source # | |
Defined in Amazonka.SWF.RegisterActivityType Methods showsPrec :: Int -> RegisterActivityTypeResponse -> ShowS # show :: RegisterActivityTypeResponse -> String # showList :: [RegisterActivityTypeResponse] -> ShowS # | |
Generic RegisterActivityTypeResponse Source # | |
Defined in Amazonka.SWF.RegisterActivityType Associated Types type Rep RegisterActivityTypeResponse :: Type -> Type # | |
NFData RegisterActivityTypeResponse Source # | |
Defined in Amazonka.SWF.RegisterActivityType Methods rnf :: RegisterActivityTypeResponse -> () # | |
type Rep RegisterActivityTypeResponse Source # | |
Defined in Amazonka.SWF.RegisterActivityType |
newRegisterActivityTypeResponse :: RegisterActivityTypeResponse Source #
Create a value of RegisterActivityTypeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.