Skip to content

Action

Source code in docs_src/capo_glue/types/action.py
class Action(TypedDict, closed=True):
    job_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of a job to be run.</p>"""
    arguments: NotRequired["capo_glue.types.generic_map.GenericMap"]
    """<p>The job arguments used when this trigger fires. For this job run, they replace the default arguments set in the job definition itself.</p> <p>You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.</p> <p>For information about how to specify and consume your own Job arguments, see the <a href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html">Calling Glue APIs in Python</a> topic in the developer guide.</p> <p>For information about the key-value pairs that Glue consumes to set up your job, see the <a href="https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html">Special Parameters Used by Glue</a> topic in the developer guide.</p>"""
    timeout: NotRequired["capo_glue.types.timeout.Timeout"]
    """<p>The <code>JobRun</code> timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters <code>TIMEOUT</code> status. This overrides the timeout value set in the parent job.</p> <p>Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.</p> <p>When the value is left blank, the timeout is defaulted to 2,880 minutes for Glue version 4.0 and earlier, or 480 minutes for Glue version 5.0 and later.</p> <p>Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.</p> <p>For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.</p>"""
    security_configuration: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the <code>SecurityConfiguration</code> structure to be used with this action.</p>"""
    notification_property: NotRequired[
        "capo_glue.types.notification_property.NotificationProperty"
    ]
    """<p>Specifies configuration properties of a job run notification.</p>"""
    crawler_name: NotRequired["capo_glue.types.name_string.NameString"]
    """<p>The name of the crawler to be used with this action.</p>"""

arguments instance-attribute

arguments: NotRequired[GenericMap]

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.

crawler_name instance-attribute

crawler_name: NotRequired[NameString]

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

job_name instance-attribute

job_name: NotRequired[NameString]

The name of a job to be run.

notification_property instance-attribute

notification_property: NotRequired[NotificationProperty]

Specifies configuration properties of a job run notification.

security_configuration instance-attribute

security_configuration: NotRequired[NameString]

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

timeout instance-attribute

timeout: NotRequired[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. This overrides the timeout value set in the parent job.

Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.

When the value is left blank, the timeout is defaulted to 2,880 minutes for Glue version 4.0 and earlier, or 480 minutes for Glue version 5.0 and later.

Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.

For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.