amazonka-swf-2.0: Amazon Simple Workflow Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

Description

 
Synopsis

Documentation

data ActivityTaskScheduledEventAttributes Source #

Provides the details of the ActivityTaskScheduled event.

See: newActivityTaskScheduledEventAttributes smart constructor.

Constructors

ActivityTaskScheduledEventAttributes' 

Fields

  • control :: Maybe Text

    Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

  • heartbeatTimeout :: Maybe Text

    The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

  • input :: Maybe Text

    The input provided to the activity task.

  • scheduleToCloseTimeout :: Maybe Text

    The maximum amount of time for this activity task.

  • scheduleToStartTimeout :: Maybe Text

    The maximum amount of time the activity task can wait to be assigned to a worker.

  • startToCloseTimeout :: Maybe Text

    The maximum amount of time a worker may take to process the activity task.

  • taskPriority :: Maybe Text

    The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

    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.

  • activityType :: ActivityType

    The type of the activity task.

  • activityId :: Text

    The unique ID of the activity task.

  • taskList :: TaskList

    The task list in which the activity task has been scheduled.

  • decisionTaskCompletedEventId :: Integer

    The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

Instances

Instances details
FromJSON ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

Generic ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

Read ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

Show ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

NFData ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

Eq ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

Hashable ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

type Rep ActivityTaskScheduledEventAttributes Source # 
Instance details

Defined in Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes

type Rep ActivityTaskScheduledEventAttributes = D1 ('MetaData "ActivityTaskScheduledEventAttributes" "Amazonka.SWF.Types.ActivityTaskScheduledEventAttributes" "amazonka-swf-2.0-DdTBZQl9wbxDbv1sov8BbM" 'False) (C1 ('MetaCons "ActivityTaskScheduledEventAttributes'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "control") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "heartbeatTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "scheduleToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduleToStartTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :*: ((S1 ('MetaSel ('Just "startToCloseTimeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "taskPriority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "activityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ActivityType))) :*: (S1 ('MetaSel ('Just "activityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "taskList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 TaskList) :*: S1 ('MetaSel ('Just "decisionTaskCompletedEventId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))))))

newActivityTaskScheduledEventAttributes Source #

Create a value of ActivityTaskScheduledEventAttributes 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:control:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_control - Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

$sel:heartbeatTimeout:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_heartbeatTimeout - The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

$sel:input:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_input - The input provided to the activity task.

$sel:scheduleToCloseTimeout:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_scheduleToCloseTimeout - The maximum amount of time for this activity task.

$sel:scheduleToStartTimeout:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_scheduleToStartTimeout - The maximum amount of time the activity task can wait to be assigned to a worker.

$sel:startToCloseTimeout:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_startToCloseTimeout - The maximum amount of time a worker may take to process the activity task.

$sel:taskPriority:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_taskPriority - The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

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:activityType:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_activityType - The type of the activity task.

$sel:activityId:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_activityId - The unique ID of the activity task.

$sel:taskList:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_taskList - The task list in which the activity task has been scheduled.

$sel:decisionTaskCompletedEventId:ActivityTaskScheduledEventAttributes', activityTaskScheduledEventAttributes_decisionTaskCompletedEventId - The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.

activityTaskScheduledEventAttributes_control :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

Data attached to the event that can be used by the decider in subsequent workflow tasks. This data isn't sent to the activity.

activityTaskScheduledEventAttributes_heartbeatTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The maximum time before which the worker processing this task must report progress by calling RecordActivityTaskHeartbeat. If the timeout is exceeded, the activity task is automatically timed out. If the worker subsequently attempts to record a heartbeat or return a result, it is ignored.

activityTaskScheduledEventAttributes_scheduleToStartTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The maximum amount of time the activity task can wait to be assigned to a worker.

activityTaskScheduledEventAttributes_startToCloseTimeout :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The maximum amount of time a worker may take to process the activity task.

activityTaskScheduledEventAttributes_taskPriority :: Lens' ActivityTaskScheduledEventAttributes (Maybe Text) Source #

The priority to assign to the scheduled activity task. If set, this overrides any default priority value that was assigned when the activity type was registered.

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.

activityTaskScheduledEventAttributes_taskList :: Lens' ActivityTaskScheduledEventAttributes TaskList Source #

The task list in which the activity task has been scheduled.

activityTaskScheduledEventAttributes_decisionTaskCompletedEventId :: Lens' ActivityTaskScheduledEventAttributes Integer Source #

The ID of the DecisionTaskCompleted event corresponding to the decision that resulted in the scheduling of this activity task. This information can be useful for diagnosing problems by tracing back the chain of events leading up to this event.