Glue / Client / get_workflow_runs

get_workflow_runs#

Glue.Client.get_workflow_runs(**kwargs)#

Retrieves metadata for all runs of a given workflow.

Request Syntax

response = client.get_workflow_runs(
    Name='string',
    IncludeGraph=True|False,
    NextToken='string',
    MaxResults=123
)

Parameters:

Name (string) –
[REQUIRED]

Name of the workflow whose metadata of runs should be returned.
IncludeGraph (boolean) – Specifies whether to include the workflow graph in response or not.
NextToken (string) – The maximum size of the response.
MaxResults (integer) – The maximum number of workflow runs to be included in the response.

Return type:

dict

Returns:

Response Syntax

{
    'Runs': [
        {
            'Name': 'string',
            'WorkflowRunId': 'string',
            'PreviousRunId': 'string',
            'WorkflowRunProperties': {
                'string': 'string'
            },
            'StartedOn': datetime(2015, 1, 1),
            'CompletedOn': datetime(2015, 1, 1),
            'Status': 'RUNNING'|'COMPLETED'|'STOPPING'|'STOPPED'|'ERROR',
            'ErrorMessage': 'string',
            'Statistics': {
                'TotalActions': 123,
                'TimeoutActions': 123,
                'FailedActions': 123,
                'StoppedActions': 123,
                'SucceededActions': 123,
                'RunningActions': 123,
                'ErroredActions': 123,
                'WaitingActions': 123
            },
            'Graph': {
                'Nodes': [
                    {
                        'Type': 'CRAWLER'|'JOB'|'TRIGGER',
                        'Name': 'string',
                        'UniqueId': 'string',
                        'TriggerDetails': {
                            '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',
                                            'CrawlerName': 'string',
                                            'CrawlState': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR'
                                        },
                                    ]
                                },
                                'EventBatchingCondition': {
                                    'BatchSize': 123,
                                    'BatchWindow': 123
                                }
                            }
                        },
                        'JobDetails': {
                            'JobRuns': [
                                {
                                    'Id': 'string',
                                    'Attempt': 123,
                                    'PreviousRunId': 'string',
                                    'TriggerName': 'string',
                                    'JobName': 'string',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'LastModifiedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'JobRunState': 'STARTING'|'RUNNING'|'STOPPING'|'STOPPED'|'SUCCEEDED'|'FAILED'|'TIMEOUT'|'ERROR'|'WAITING',
                                    'Arguments': {
                                        'string': 'string'
                                    },
                                    'ErrorMessage': 'string',
                                    'PredecessorRuns': [
                                        {
                                            'JobName': 'string',
                                            'RunId': 'string'
                                        },
                                    ],
                                    'AllocatedCapacity': 123,
                                    'ExecutionTime': 123,
                                    'Timeout': 123,
                                    'MaxCapacity': 123.0,
                                    'WorkerType': 'Standard'|'G.1X'|'G.2X'|'G.025X'|'G.4X'|'G.8X',
                                    'NumberOfWorkers': 123,
                                    'SecurityConfiguration': 'string',
                                    'LogGroupName': 'string',
                                    'NotificationProperty': {
                                        'NotifyDelayAfter': 123
                                    },
                                    'GlueVersion': 'string',
                                    'DPUSeconds': 123.0,
                                    'ExecutionClass': 'FLEX'|'STANDARD'
                                },
                            ]
                        },
                        'CrawlerDetails': {
                            'Crawls': [
                                {
                                    'State': 'RUNNING'|'CANCELLING'|'CANCELLED'|'SUCCEEDED'|'FAILED'|'ERROR',
                                    'StartedOn': datetime(2015, 1, 1),
                                    'CompletedOn': datetime(2015, 1, 1),
                                    'ErrorMessage': 'string',
                                    'LogGroup': 'string',
                                    'LogStream': 'string'
                                },
                            ]
                        }
                    },
                ],
                'Edges': [
                    {
                        'SourceId': 'string',
                        'DestinationId': 'string'
                    },
                ]
            },
            'StartingEventBatchCondition': {
                'BatchSize': 123,
                'BatchWindow': 123
            }
        },
    ],
    'NextToken': 'string'
}

Response Structure

(dict) –
- Runs (list) –
  
  A list of workflow run metadata objects.
  - (dict) –
    
    A workflow run is an execution of a workflow providing all the runtime information.
    - Name (string) –
      
      Name of the workflow that was run.
    - WorkflowRunId (string) –
      
      The ID of this workflow run.
    - PreviousRunId (string) –
      
      The ID of the previous workflow run.
    - WorkflowRunProperties (dict) –
      
      The workflow run properties which were set during the run.
      - (string) –
        
        (string) –
    - StartedOn (datetime) –
      
      The date and time when the workflow run was started.
    - CompletedOn (datetime) –
      
      The date and time when the workflow run completed.
    - Status (string) –
      
      The status of the workflow run.
    - ErrorMessage (string) –
      
      This error message describes any error that may have occurred in starting the workflow run. Currently the only error message is “Concurrent runs exceeded for workflow: foo.”
    - Statistics (dict) –
      
      The statistics of the run.
      - TotalActions (integer) –
        
        Total number of Actions in the workflow run.
      - TimeoutActions (integer) –
        
        Total number of Actions that timed out.
      - FailedActions (integer) –
        
        Total number of Actions that have failed.
      - StoppedActions (integer) –
        
        Total number of Actions that have stopped.
      - SucceededActions (integer) –
        
        Total number of Actions that have succeeded.
      - RunningActions (integer) –
        
        Total number Actions in running state.
      - ErroredActions (integer) –
        
        Indicates the count of job runs in the ERROR state in the workflow run.
      - WaitingActions (integer) –
        
        Indicates the count of job runs in WAITING state in the workflow run.
    - Graph (dict) –
      
      The graph representing all the Glue components that belong to the workflow as nodes and directed connections between them as edges.
      - Nodes (list) –
        
        A list of the the Glue components belong to the workflow represented as nodes.
        
        (dict) –
        
        A node represents an Glue component (trigger, crawler, or job) on a workflow graph.
        
        Type (string) –
        
        The type of Glue component represented by the node.
        
        Name (string) –
        
        The name of the Glue component represented by the node.
        
        UniqueId (string) –
        
        The unique Id assigned to the node within the workflow.
        
        TriggerDetails (dict) –
        
        Details of the Trigger when the node represents a Trigger.
        
        Trigger (dict) –
        
        The information of the trigger represented by the trigger node.
        
        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.
        
        JobDetails (dict) –
        
        Details of the Job when the node represents a Job.
        
        JobRuns (list) –
        
        The information for the job runs represented by the job node.
        
        (dict) –
        
        Contains information about a job run.
        
        Id (string) –
        
        The ID of this job run.
        
        Attempt (integer) –
        
        The number of the attempt to run this job.
        
        PreviousRunId (string) –
        
        The ID of the previous run of this job. For example, the JobRunId specified in the StartJobRun action.
        
        TriggerName (string) –
        
        The name of the trigger that started this job run.
        
        JobName (string) –
        
        The name of the job definition being used in this run.
        
        StartedOn (datetime) –
        
        The date and time at which this job run was started.
        
        LastModifiedOn (datetime) –
        
        The last time that this job run was modified.
        
        CompletedOn (datetime) –
        
        The date and time that this job run completed.
        
        JobRunState (string) –
        
        The current state of the job run. For more information about the statuses of jobs that have terminated abnormally, see Glue Job Run Statuses.
        
        Arguments (dict) –
        
        The job arguments associated with this run. 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) –
        
        ErrorMessage (string) –
        
        An error message associated with this job run.
        
        PredecessorRuns (list) –
        
        A list of predecessors to this job run.
        
        (dict) –
        
        A job run that was used in the predicate of a conditional trigger that triggered this job run.
        
        JobName (string) –
        
        The name of the job definition used by the predecessor job run.
        
        RunId (string) –
        
        The job-run ID of the predecessor job run.
        
        AllocatedCapacity (integer) –
        
        This field is deprecated. Use MaxCapacity instead.
        
        The number of Glue data processing units (DPUs) allocated to this JobRun. From 2 to 100 DPUs can be allocated; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
        
        ExecutionTime (integer) –
        
        The amount of time (in seconds) that the job run consumed resources.
        
        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. This value overrides the timeout value set in the parent job.
        
        Streaming jobs do not have a timeout. The default for non-streaming jobs is 2,880 minutes (48 hours).
        
        MaxCapacity (float) –
        
        The number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
        
        Do not set Max Capacity if using WorkerType and NumberOfWorkers.
        
        The value that can be allocated for MaxCapacity depends on whether you are running a Python shell job or an Apache Spark ETL job:
        
        When you specify a Python shell job ( ``JobCommand.Name``=”pythonshell”), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU.
        
        When you specify an Apache Spark ETL job ( ``JobCommand.Name``=”glueetl”), you can allocate a minimum of 2 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
        
        WorkerType (string) –
        
        The type of predefined worker that is allocated when a job runs. Accepts a value of Standard, G.1X, G.2X, or G.025X.
        
        For the Standard worker type, each worker provides 4 vCPU, 16 GB of memory and a 50GB disk, and 2 executors per worker.
        
        For the G.1X worker type, each worker provides 4 vCPU, 16 GB of memory and a 64GB disk, and 1 executor per worker.
        
        For the G.2X worker type, each worker provides 8 vCPU, 32 GB of memory and a 128GB disk, and 1 executor per worker.
        
        For the G.025X worker type, each worker maps to 0.25 DPU (2 vCPU, 4 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
        
        NumberOfWorkers (integer) –
        
        The number of workers of a defined workerType that are allocated when a job runs.
        
        SecurityConfiguration (string) –
        
        The name of the SecurityConfiguration structure to be used with this job run.
        
        LogGroupName (string) –
        
        The name of the log group for secure logging that can be server-side encrypted in Amazon CloudWatch using KMS. This name can be /aws-glue/jobs/, in which case the default encryption is NONE. If you add a role name and SecurityConfiguration name (in other words, /aws-glue/jobs-yourRoleName-yourSecurityConfigurationName/), then that security configuration is used to encrypt the log group.
        
        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.
        
        GlueVersion (string) –
        
        Glue version determines the versions of Apache Spark and Python that Glue supports. The Python version indicates the version supported for jobs of type Spark.
        
        For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
        
        Jobs that are created without specifying a Glue version default to Glue 0.9.
        
        DPUSeconds (float) –
        
        This field populates only for Auto Scaling job runs, and represents the total time each executor ran during the lifecycle of a job run in seconds, multiplied by a DPU factor (1 for G.1X, 2 for G.2X, or 0.25 for G.025X workers). This value may be different than the executionEngineRuntime * MaxCapacity as in the case of Auto Scaling jobs, as the number of executors running at a given time may be less than the MaxCapacity. Therefore, it is possible that the value of DPUSeconds is less than executionEngineRuntime * MaxCapacity.
        
        ExecutionClass (string) –
        
        Indicates whether the job is run with a standard or flexible execution class. The standard execution-class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
        
        The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
        
        Only jobs with Glue version 3.0 and above and command type glueetl will be allowed to set ExecutionClass to FLEX. The flexible execution class is available for Spark jobs.
        
        CrawlerDetails (dict) –
        
        Details of the crawler when the node represents a crawler.
        
        Crawls (list) –
        
        A list of crawls represented by the crawl node.
        
        (dict) –
        
        The details of a crawl in the workflow.
        
        State (string) –
        
        The state of the crawler.
        
        StartedOn (datetime) –
        
        The date and time on which the crawl started.
        
        CompletedOn (datetime) –
        
        The date and time on which the crawl completed.
        
        ErrorMessage (string) –
        
        The error message associated with the crawl.
        
        LogGroup (string) –
        
        The log group associated with the crawl.
        
        LogStream (string) –
        
        The log stream associated with the crawl.
      - Edges (list) –
        
        A list of all the directed connections between the nodes belonging to the workflow.
        
        (dict) –
        
        An edge represents a directed connection between two Glue components that are part of the workflow the edge belongs to.
        
        SourceId (string) –
        
        The unique of the node within the workflow where the edge starts.
        
        DestinationId (string) –
        
        The unique of the node within the workflow where the edge ends.
    - StartingEventBatchCondition (dict) –
      
      The batch condition that started the workflow run.
      - BatchSize (integer) –
        
        Number of events in the batch.
      - BatchWindow (integer) –
        
        Duration of the batch window in seconds.
- NextToken (string) –
  
  A continuation token, if not all requested workflow runs have been returned.

Exceptions

Glue.Client.exceptions.InvalidInputException
Glue.Client.exceptions.EntityNotFoundException
Glue.Client.exceptions.InternalServiceException
Glue.Client.exceptions.OperationTimeoutException