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 |
Synopsis
- data ActivityTypeConfiguration = ActivityTypeConfiguration' {}
- newActivityTypeConfiguration :: ActivityTypeConfiguration
- activityTypeConfiguration_defaultTaskScheduleToStartTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)
- activityTypeConfiguration_defaultTaskList :: Lens' ActivityTypeConfiguration (Maybe TaskList)
- activityTypeConfiguration_defaultTaskPriority :: Lens' ActivityTypeConfiguration (Maybe Text)
- activityTypeConfiguration_defaultTaskHeartbeatTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)
- activityTypeConfiguration_defaultTaskScheduleToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)
- activityTypeConfiguration_defaultTaskStartToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)
Documentation
data ActivityTypeConfiguration Source #
Configuration settings registered with the activity type.
See: newActivityTypeConfiguration
smart constructor.
ActivityTypeConfiguration' | |
|
Instances
newActivityTypeConfiguration :: ActivityTypeConfiguration Source #
Create a value of ActivityTypeConfiguration
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:ActivityTypeConfiguration'
, activityTypeConfiguration_defaultTaskScheduleToStartTimeout
- The default maximum duration, specified when registering the activity
type, that a task of an activity type can wait before being assigned to
a worker. You can override this default when scheduling a task through
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:ActivityTypeConfiguration'
, activityTypeConfiguration_defaultTaskList
- The default task list specified for this activity type at registration.
This default is used if a task list isn't provided when a task is
scheduled through the ScheduleActivityTask
Decision. You can override
the default registered task list when scheduling a task through the
ScheduleActivityTask
Decision.
$sel:defaultTaskPriority:ActivityTypeConfiguration'
, activityTypeConfiguration_defaultTaskPriority
- The default task priority for tasks of this activity type, specified at
registration. If not set, then 0
is used as the default priority. This
default can be overridden when scheduling an activity task.
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:defaultTaskHeartbeatTimeout:ActivityTypeConfiguration'
, activityTypeConfiguration_defaultTaskHeartbeatTimeout
- The default maximum time, in seconds, before which a worker processing a
task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The
registered default value can be overridden when you schedule a task
through 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:ActivityTypeConfiguration'
, activityTypeConfiguration_defaultTaskScheduleToCloseTimeout
- The default maximum duration, specified when registering the activity
type, for tasks of this activity type. You can override this default
when scheduling a task through 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:ActivityTypeConfiguration'
, activityTypeConfiguration_defaultTaskStartToCloseTimeout
- The default maximum duration for tasks of an activity type specified
when registering the activity type. You can override this default when
scheduling a task through 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.
activityTypeConfiguration_defaultTaskScheduleToStartTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #
The default maximum duration, specified when registering the activity
type, that a task of an activity type can wait before being assigned to
a worker. You can override this default when scheduling a task through
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.
activityTypeConfiguration_defaultTaskList :: Lens' ActivityTypeConfiguration (Maybe TaskList) Source #
The default task list specified for this activity type at registration.
This default is used if a task list isn't provided when a task is
scheduled through the ScheduleActivityTask
Decision. You can override
the default registered task list when scheduling a task through the
ScheduleActivityTask
Decision.
activityTypeConfiguration_defaultTaskPriority :: Lens' ActivityTypeConfiguration (Maybe Text) Source #
The default task priority for tasks of this activity type, specified at
registration. If not set, then 0
is used as the default priority. This
default can be overridden when scheduling an activity task.
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.
activityTypeConfiguration_defaultTaskHeartbeatTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #
The default maximum time, in seconds, before which a worker processing a task must report progress by calling RecordActivityTaskHeartbeat.
You can specify this value only when registering an activity type. The
registered default value can be overridden when you schedule a task
through 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.
activityTypeConfiguration_defaultTaskScheduleToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #
The default maximum duration, specified when registering the activity
type, for tasks of this activity type. You can override this default
when scheduling a task through 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.
activityTypeConfiguration_defaultTaskStartToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text) Source #
The default maximum duration for tasks of an activity type specified
when registering the activity type. You can override this default when
scheduling a task through 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.