Amazonka.SWF.Types.ActivityTypeConfiguration

Documentation

data ActivityTypeConfiguration

Configuration settings registered with the activity type.

See: newActivityTypeConfiguration smart constructor.

Constructors

ActivityTypeConfiguration'

Fields

• defaultTaskHeartbeatTimeout :: Maybe Text

  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.

• defaultTaskList :: Maybe TaskList

  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.

• defaultTaskPriority :: Maybe Text

  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.

• defaultTaskScheduleToCloseTimeout :: Maybe Text

  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.

• defaultTaskScheduleToStartTimeout :: Maybe Text

  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.

• defaultTaskStartToCloseTimeout :: Maybe Text

  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.

Instances

FromJSON ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

Methods

parseJSON :: Value -> Parser ActivityTypeConfiguration

parseJSONList :: Value -> Parser [ActivityTypeConfiguration]

Generic ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

Associated Types

type Rep ActivityTypeConfiguration :: Type -> Type

Methods

from :: ActivityTypeConfiguration -> Rep ActivityTypeConfiguration x

to :: Rep ActivityTypeConfiguration x -> ActivityTypeConfiguration

Read ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

Methods

readsPrec :: Int -> ReadS ActivityTypeConfiguration

readList :: ReadS [ActivityTypeConfiguration]

readPrec :: ReadPrec ActivityTypeConfiguration

readListPrec :: ReadPrec [ActivityTypeConfiguration]

Show ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

Methods

showsPrec :: Int -> ActivityTypeConfiguration -> ShowS

show :: ActivityTypeConfiguration -> String

showList :: [ActivityTypeConfiguration] -> ShowS

NFData ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

Methods

rnf :: ActivityTypeConfiguration -> ()

Eq ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

Methods

(==) :: ActivityTypeConfiguration -> ActivityTypeConfiguration -> Bool

(/=) :: ActivityTypeConfiguration -> ActivityTypeConfiguration -> Bool

Hashable ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

Methods

hashWithSalt :: Int -> ActivityTypeConfiguration -> Int

hash :: ActivityTypeConfiguration -> Int

type Rep ActivityTypeConfiguration

Defined in Amazonka.SWF.Types.ActivityTypeConfiguration

type Rep ActivityTypeConfiguration = D1 ('MetaData "ActivityTypeConfiguration" "Amazonka.SWF.Types.ActivityTypeConfiguration" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "ActivityTypeConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "defaultTaskHeartbeatTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultTaskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskList)) :*: S1 ('MetaSel ('Just "defaultTaskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "defaultTaskScheduleToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "defaultTaskScheduleToStartTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "defaultTaskStartToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newActivityTypeConfiguration :: ActivityTypeConfiguration

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: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: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: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: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: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_defaultTaskHeartbeatTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)

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_defaultTaskList :: Lens' ActivityTypeConfiguration (Maybe TaskList)

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)

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_defaultTaskScheduleToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)

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_defaultTaskScheduleToStartTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)

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_defaultTaskStartToCloseTimeout :: Lens' ActivityTypeConfiguration (Maybe Text)

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.