[ aws . glue ]

get-workflow

Description

Retrieves resource metadata for a workflow.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  get-workflow
--name <value>
[--include-graph | --no-include-graph]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the workflow to retrieve.

--include-graph | --no-include-graph (boolean)

Specifies whether to include a graph when returning the workflow resource metadata.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

Workflow -> (structure)

The resource metadata for the workflow.

Name -> (string)

The name of the workflow representing the flow.

Description -> (string)

A description of the workflow.

DefaultRunProperties -> (map)

A collection of properties to be used as part of each execution of the workflow.

key -> (string)

value -> (string)

CreatedOn -> (timestamp)

The date and time when the workflow was created.

LastModifiedOn -> (timestamp)

The date and time when the workflow was last modified.

LastRun -> (structure)

The information about the last execution of the workflow.

Name -> (string)

Name of the workflow that was executed.

WorkflowRunId -> (string)

The ID of this workflow run.

PreviousRunId -> (string)

The ID of the previous workflow run.

WorkflowRunProperties -> (map)

The workflow run properties which were set during the run.

key -> (string)

value -> (string)

StartedOn -> (timestamp)

The date and time when the workflow run was started.

CompletedOn -> (timestamp)

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 -> (structure)

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.

Graph -> (structure)

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Nodes -> (list)

A list of the the AWS Glue components belong to the workflow represented as nodes.

(structure)

A node represents an AWS Glue component such as a trigger, or job, etc., that is part of a workflow.

Type -> (string)

The type of AWS Glue component represented by the node.

Name -> (string)

The name of the AWS Glue component represented by the node.

UniqueId -> (string)

The unique Id assigned to the node within the workflow.

TriggerDetails -> (structure)

Details of the Trigger when the node represents a Trigger.

Trigger -> (structure)

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.

(structure)

Defines an action to be initiated by a trigger.

JobName -> (string)

The name of a job to be executed.

Arguments -> (map)

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 AWS Glue itself consumes.

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

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

key -> (string)

value -> (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 -> (structure)

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 -> (structure)

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.

(structure)

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.

JobDetails -> (structure)

Details of the Job when the node represents a Job.

JobRuns -> (list)

The information for the job runs represented by the job node.

(structure)

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 -> (timestamp)

The date and time at which this job run was started.

LastModifiedOn -> (timestamp)

The last time that this job run was modified.

CompletedOn -> (timestamp)

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 AWS Glue Job Run Statuses .

Arguments -> (map)

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 AWS Glue itself consumes.

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

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

key -> (string)

value -> (string)

ErrorMessage -> (string)

An error message associated with this job run.

PredecessorRuns -> (list)

A list of predecessors to this job run.

(structure)

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 AWS 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 AWS 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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

MaxCapacity -> (double)

The number of AWS 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 AWS 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 from 2 to 100 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, or G.2X.

• 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.

NumberOfWorkers -> (integer)

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

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 AWS 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 -> (structure)

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 AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS 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.

CrawlerDetails -> (structure)

Details of the crawler when the node represents a crawler.

Crawls -> (list)

A list of crawls represented by the crawl node.

(structure)

The details of a crawl in the workflow.

State -> (string)

The state of the crawler.

StartedOn -> (timestamp)

The date and time on which the crawl started.

CompletedOn -> (timestamp)

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.

(structure)

An edge represents a directed connection between two AWS 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.

Graph -> (structure)

The graph representing all the AWS Glue components that belong to the workflow as nodes and directed connections between them as edges.

Nodes -> (list)

A list of the the AWS Glue components belong to the workflow represented as nodes.

(structure)

A node represents an AWS Glue component such as a trigger, or job, etc., that is part of a workflow.

Type -> (string)

The type of AWS Glue component represented by the node.

Name -> (string)

The name of the AWS Glue component represented by the node.

UniqueId -> (string)

The unique Id assigned to the node within the workflow.

TriggerDetails -> (structure)

Details of the Trigger when the node represents a Trigger.

Trigger -> (structure)

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.

(structure)

Defines an action to be initiated by a trigger.

JobName -> (string)

The name of a job to be executed.

Arguments -> (map)

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 AWS Glue itself consumes.

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

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

key -> (string)

value -> (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 -> (structure)

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 -> (structure)

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.

(structure)

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.

JobDetails -> (structure)

Details of the Job when the node represents a Job.

JobRuns -> (list)

The information for the job runs represented by the job node.

(structure)

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 -> (timestamp)

The date and time at which this job run was started.

LastModifiedOn -> (timestamp)

The last time that this job run was modified.

CompletedOn -> (timestamp)

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 AWS Glue Job Run Statuses .

Arguments -> (map)

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 AWS Glue itself consumes.

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

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

key -> (string)

value -> (string)

ErrorMessage -> (string)

An error message associated with this job run.

PredecessorRuns -> (list)

A list of predecessors to this job run.

(structure)

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 AWS 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 AWS 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. The default is 2,880 minutes (48 hours). This overrides the timeout value set in the parent job.

MaxCapacity -> (double)

The number of AWS 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 AWS 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 from 2 to 100 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, or G.2X.

• 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.

NumberOfWorkers -> (integer)

The number of workers of a defined workerType that are allocated when a job runs.

The maximum number of workers you can define are 299 for G.1X , and 149 for G.2X .

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 AWS 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 -> (structure)

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 AWS Glue supports. The Python version indicates the version supported for jobs of type Spark.

For more information about the available AWS 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.

CrawlerDetails -> (structure)

Details of the crawler when the node represents a crawler.

Crawls -> (list)

A list of crawls represented by the crawl node.

(structure)

The details of a crawl in the workflow.

State -> (string)

The state of the crawler.

StartedOn -> (timestamp)

The date and time on which the crawl started.

CompletedOn -> (timestamp)

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.

(structure)

An edge represents a directed connection between two AWS 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.

MaxConcurrentRuns -> (integer)

You can use this parameter to prevent unwanted multiple updates to data, to control costs, or in some cases, to prevent exceeding the maximum number of concurrent runs of any of the component jobs. If you leave this parameter blank, there is no limit to the number of concurrent workflow runs.