Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Glue.Types.Action

Description

Synopsis

data Action = Action' {
- arguments :: Maybe (HashMap Text Text)
- crawlerName :: Maybe Text
- jobName :: Maybe Text
- notificationProperty :: Maybe NotificationProperty
- securityConfiguration :: Maybe Text
- timeout :: Maybe Natural
}
newAction :: Action
action_arguments :: Lens' Action (Maybe (HashMap Text Text))
action_crawlerName :: Lens' Action (Maybe Text)
action_jobName :: Lens' Action (Maybe Text)
action_notificationProperty :: Lens' Action (Maybe NotificationProperty)
action_securityConfiguration :: Lens' Action (Maybe Text)
action_timeout :: Lens' Action (Maybe Natural)

Documentation

data Action Source #

Defines an action to be initiated by a trigger.

See: newAction smart constructor.

Constructors

Action'

Fields

arguments :: Maybe (HashMap Text Text)
The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.
crawlerName :: Maybe Text
The name of the crawler to be used with this action.
jobName :: Maybe Text
The name of a job to be run.
notificationProperty :: Maybe NotificationProperty
Specifies configuration properties of a job run notification.
securityConfiguration :: Maybe Text
The name of the SecurityConfiguration structure to be used with this action.
timeout :: Maybe Natural
The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

Instances

Instances details

FromJSON Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Methods parseJSON :: Value -> Parser Action # parseJSONList :: Value -> Parser [Action] #
ToJSON Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Methods toJSON :: Action -> Value # toEncoding :: Action -> Encoding # toJSONList :: [Action] -> Value # toEncodingList :: [Action] -> Encoding #
Generic Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Associated Types type Rep Action :: Type -> Type # Methods from :: Action -> Rep Action x # to :: Rep Action x -> Action #
Read Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Methods readsPrec :: Int -> ReadS Action # readList :: ReadS [Action] # readPrec :: ReadPrec Action # readListPrec :: ReadPrec [Action] #
Show Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Methods showsPrec :: Int -> Action -> ShowS # show :: Action -> String # showList :: [Action] -> ShowS #
NFData Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Methods rnf :: Action -> () #
Eq Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Methods (==) :: Action -> Action -> Bool # (/=) :: Action -> Action -> Bool #
Hashable Action Source #
Instance details Defined in Amazonka.Glue.Types.Action Methods hashWithSalt :: Int -> Action -> Int # hash :: Action -> Int #
type Rep Action Source #
Instance details Defined in Amazonka.Glue.Types.Action type Rep Action = D1 ('MetaData "Action" "Amazonka.Glue.Types.Action" "amazonka-glue-2.0-7miPWwBHdfn8N8SvbpLgE0" 'False) (C1 ('MetaCons "Action'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "arguments") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: (S1 ('MetaSel ('Just "crawlerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "notificationProperty") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NotificationProperty)) :: (S1 ('MetaSel ('Just "securityConfiguration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "timeout") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural))))))

newAction :: Action Source #

Create a value of Action 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:arguments:Action', action_arguments - The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

$sel:crawlerName:Action', action_crawlerName - The name of the crawler to be used with this action.

$sel:jobName:Action', action_jobName - The name of a job to be run.

$sel:notificationProperty:Action', action_notificationProperty - Specifies configuration properties of a job run notification.

$sel:securityConfiguration:Action', action_securityConfiguration - The name of the SecurityConfiguration structure to be used with this action.

$sel:timeout:Action', action_timeout - The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

action_arguments :: Lens' Action (Maybe (HashMap Text Text)) Source #

The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.

You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.

For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.

For information about the key-value pairs that Glue consumes to set up your job, see the Special Parameters Used by Glue topic in the developer guide.

action_crawlerName :: Lens' Action (Maybe Text) Source #

The name of the crawler to be used with this action.

action_jobName :: Lens' Action (Maybe Text) Source #

The name of a job to be run.

action_notificationProperty :: Lens' Action (Maybe NotificationProperty) Source #

Specifies configuration properties of a job run notification.

action_securityConfiguration :: Lens' Action (Maybe Text) Source #

The name of the SecurityConfiguration structure to be used with this action.

action_timeout :: Lens' Action (Maybe Natural) Source #

The JobRun timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT status. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.