Glue / Client / update_trigger

update_trigger#

Glue.Client.update_trigger(**kwargs)#

Updates a trigger definition.

Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Amazon Web Services Secrets Manager or other secret management mechanism if you intend to keep them within the Job.

See also: AWS API Documentation

Request Syntax

response = client.update_trigger(
    Name='string',
    TriggerUpdate={
        'Name': 'string',
        'Description': 'string',
        'Schedule': 'string',
        'Actions': [
            {
                'JobName': 'string',
                'Arguments': {
                    'string': 'string'
                },
                'Timeout': 123,
                'SecurityConfiguration': 'string',
                'NotificationProperty': {
                    'NotifyDelayAfter': 123
                },
                'CrawlerName': 'string'
            },
        ],
        'Predicate': {
            'Logical': 'AND'|'ANY',
            'Conditions': [
                {
                    'LogicalOperator': 'EQUALS',
                    'JobName': 'string',
                    'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING'|'EXPIRED',
                    'CrawlerName': 'string',
                    'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR'
                },
            ]
        },
        'EventBatchingCondition': {
            'BatchSize': 123,
            'BatchWindow': 123
        }
    }
)
Parameters:

  • Name (string) –

    [REQUIRED]

    The name of the trigger to update.

  • TriggerUpdate (dict) –

    [REQUIRED]

    The new values with which to update the trigger.

    • Name (string) –

      Reserved for future use.

    • Description (string) –

      A description of this trigger.

    • Schedule (string) –

      A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

    • Actions (list) –

      The actions initiated by this trigger.

      • (dict) –

        Defines an action to be initiated by a trigger.

        • JobName (string) –

          The name of a job to be run.

        • Arguments (dict) –

          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.

          • (string) –

            • (string) –

        • Timeout (integer) –

          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.

        • SecurityConfiguration (string) –

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

        • NotificationProperty (dict) –

          Specifies configuration properties of a job run notification.

          • NotifyDelayAfter (integer) –

            After a job run starts, the number of minutes to wait before sending a job run delay notification.

        • CrawlerName (string) –

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

    • Predicate (dict) –

      The predicate of this trigger, which defines when it will fire.

      • Logical (string) –

        An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

      • Conditions (list) –

        A list of the conditions that determine when the trigger will fire.

        • (dict) –

          Defines a condition under which a trigger fires.

          • LogicalOperator (string) –

            A logical operator.

          • JobName (string) –

            The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

          • State (string) –

            The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED, STOPPED, FAILED, and TIMEOUT. The only crawler states that a trigger can listen for are SUCCEEDED, FAILED, and CANCELLED.

          • CrawlerName (string) –

            The name of the crawler to which this condition applies.

          • CrawlState (string) –

            The state of the crawler to which this condition applies.

    • EventBatchingCondition (dict) –

      Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

      • BatchSize (integer) – [REQUIRED]

        Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.

      • BatchWindow (integer) –

        Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

Return type:

dict

Returns:

Response Syntax

{
    'Trigger': {
        'Name': 'string',
        'WorkflowName': 'string',
        'Id': 'string',
        'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND'|'EVENT',
        'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING',
        'Description': 'string',
        'Schedule': 'string',
        'Actions': [
            {
                'JobName': 'string',
                'Arguments': {
                    'string': 'string'
                },
                'Timeout': 123,
                'SecurityConfiguration': 'string',
                'NotificationProperty': {
                    'NotifyDelayAfter': 123
                },
                'CrawlerName': 'string'
            },
        ],
        'Predicate': {
            'Logical': 'AND'|'ANY',
            'Conditions': [
                {
                    'LogicalOperator': 'EQUALS',
                    'JobName': 'string',
                    'State': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING'|'EXPIRED',
                    'CrawlerName': 'string',
                    'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR'
                },
            ]
        },
        'EventBatchingCondition': {
            'BatchSize': 123,
            'BatchWindow': 123
        }
    }
}

Response Structure

  • (dict) –

    • Trigger (dict) –

      The resulting trigger definition.

      • Name (string) –

        The name of the trigger.

      • WorkflowName (string) –

        The name of the workflow associated with the trigger.

      • Id (string) –

        Reserved for future use.

      • Type (string) –

        The type of trigger that this is.

      • State (string) –

        The current state of the trigger.

      • Description (string) –

        A description of this trigger.

      • Schedule (string) –

        A cron expression used to specify the schedule (see Time-Based Schedules for Jobs and Crawlers. For example, to run something every day at 12:15 UTC, you would specify: cron(15 12 * * ? *).

      • Actions (list) –

        The actions initiated by this trigger.

        • (dict) –

          Defines an action to be initiated by a trigger.

          • JobName (string) –

            The name of a job to be run.

          • Arguments (dict) –

            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.

            • (string) –

              • (string) –

          • Timeout (integer) –

            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.

          • SecurityConfiguration (string) –

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

          • NotificationProperty (dict) –

            Specifies configuration properties of a job run notification.

            • NotifyDelayAfter (integer) –

              After a job run starts, the number of minutes to wait before sending a job run delay notification.

          • CrawlerName (string) –

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

      • Predicate (dict) –

        The predicate of this trigger, which defines when it will fire.

        • Logical (string) –

          An optional field if only one condition is listed. If multiple conditions are listed, then this field is required.

        • Conditions (list) –

          A list of the conditions that determine when the trigger will fire.

          • (dict) –

            Defines a condition under which a trigger fires.

            • LogicalOperator (string) –

              A logical operator.

            • JobName (string) –

              The name of the job whose JobRuns this condition applies to, and on which this trigger waits.

            • State (string) –

              The condition state. Currently, the only job states that a trigger can listen for are SUCCEEDED, STOPPED, FAILED, and TIMEOUT. The only crawler states that a trigger can listen for are SUCCEEDED, FAILED, and CANCELLED.

            • CrawlerName (string) –

              The name of the crawler to which this condition applies.

            • CrawlState (string) –

              The state of the crawler to which this condition applies.

      • EventBatchingCondition (dict) –

        Batch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.

        • BatchSize (integer) –

          Number of events that must be received from Amazon EventBridge before EventBridge event trigger fires.

        • BatchWindow (integer) –

          Window of time in seconds after which EventBridge event trigger fires. Window starts when first event is received.

Exceptions