...
This Universal Extension provides the capability to submit a new AWS Glue Job.
Version Information
| Template Name | Extension Name | Extension Version |
|---|---|---|
| AWS Glue | ue-aws-glue | 1.2.0 |
Refer to Changelog for version history information.
...
The input fields for this Universal Extension are described in the following table.
| Field | Input type | Default value | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
| Action | Required | Start Job Run | Choice | The action performed upon the task execution. The available actions are as follows.
| ||||||
| AWS Region Optional since version 1.1.0 | Optional | - | Text | Region for the Amazon Web Service. Find more information about the AWS Service endpoints and quotas here. When AWS Region is not populated as part of the task definition, during task execution the integration will look for credentials on the task execution environment. Refer to configuration options for more information. | ||||||
| AWS Credentials Optional since version 1.1.0 | Optional | - | Credentials | The Credentials definition should be as follows.
| ||||||
| Role Based Access | Optional | False | Boolean | Special type of authorization is provided by Role Assumption where the client sends his own credentials and the role he wants to assume from another user. If allowed, the client receives temporary credentials with limited time access to some resources. | ||||||
| Role ARN | Optional | - | Text | Role Arn: Amazon Role, which is applied for the connection. Role ARN format: Example RoleArn: arn:aws:iam::119322085622:role.Required when Role Based Access="True". | ||||||
| Job Name | Required | - | Text | Name of the Glue job that will be invoked. | ||||||
| Job Run ID | Optional | - | Text | ID of a previous Job Run to retry. | ||||||
| Security Configuration | Optional | - | Text | Name of the Security Configuration structure to be used with the Job Run. | ||||||
| Worker Type | Optional | None | Choice | Type of predefined worker that is allocated when a job runs. Available options are the following.
| ||||||
| Number Of Workers | Optional | - | Integer | Number of workers of a defined Worker Type that are allocated when a job is executed. The maximum number of workers that can be defined are as follows.
| ||||||
| Job Timeout | Optional | 2880 | Integer | Job Run timeout in minutes.
| ||||||
| Notify Delay Period | Optional | - | Integer | After a job run starts, the number of minutes to wait before sending a job run delay notification. | ||||||
Introduced in version 1.2.0 | Required | Array Field | Choice | Source of job arguments with possible choices: “Array Field” or “Script”. Job arguments replace the default arguments set in the job definition, for the current run. More info here. | ||||||
| Input Arguments Script Introduced in version 1.2.0 | Optional | - | Script | Job arguments in UAC Script in JSON format. Used to pass arguments from UAC environment variables or UAC Functions. Data Type of arguments must be string and character escaping actions to be performed where needed. Check the example for more information. Visible when Input Arguments Source is configured as "Script". Click here for more information about script creation. | ||||||
| Input Arguments | Optional | - | Array | Job arguments in array format. Visible when Input Arguments Source is configured as "Array Field". | ||||||
| Wait for Success or Failure Introduced in version 1.2.0 | Optional | False | Boolean | If selected, the task will continue running until Job reaches the "SUCCEDED" or "FAILED" state."STOPPED", "TIMEOUT","ERROR' are considered "FAILED" states. | ||||||
| Polling Interval Introduced in version 1.2.0 | Optional | 60 | Integer | The polling interval in seconds between checking for the Job status. Required when Wait for Success or Failure ="True". | ||||||
| Proxy Type | Optional | HTTP | Choice | Type of proxy connection to be used. Available options are the following.
| ||||||
| Proxy | Optional | - | Text | Comma separated list of Proxy servers. Valid formats are the following.
| ||||||
| Proxy CA Bundle File | Optional | - | Text | The path to a custom certificate bundle to use when establishing SSL/TLS connections with proxy. Used when Proxy Type is configured for "HTTPS" or "HTTPS With Credentials". | ||||||
| Proxy Credentials | Optional | - | Credentials | Credentials to be used for the proxy communication. The credential definition should be as follows.
Required when "Proxy Type" is configured for "HTTPS With Credentials". |
Task Examples
Start Job Run
...
The output fields for this Universal Extension are described below.
| Field | Type | Description |
|---|---|---|
| Job Run ID | text | ID of the started job run |
| Job Run Status | text | Status of the job run. Generated for Action "Start Job Run" and Wait for Success or Failure = "True", updating live during execution. |
Exit Codes
The exit codes for the Extension are described below.
| Exit Code | Status Classification Code | Status Classification Description | Status Description |
|---|---|---|---|
| 0 | SUCCESS | Successful Execution | SUCCESS: AWS Glue Job started successfully. |
| 0 | SUCCESS | Successful Execution with Wait for Success or Failure="True" | SUCCESS: AWS Glue Job started successfully and resulted in status SUCCEEDED. |
| 1 | FAIL | Failed Execution | FAIL: < Error Description >. |
| 1 | FAIL | Failed Execution with Wait for Success or Failure="True" | FAIL: Job Run started successfully but resulted in status < STATUS > Available values for are listed below.
|
| 2 | AUTHENTICATION_ERROR | Bad credentials | AUTHENTICATION_ERROR: Account cannot be authenticated. |
| 3 | AUTHORIZATION_ERROR | Insufficient Permissions | AUTHORIZATION_ERROR: Account is not authorized to perform the requested action. |
| 10 | CONNECTION_ERROR | Bad connection data or connection timed out | CONNECTION_ERROR: < Error Description >. |
| 11 | CONNECTION_ERROR | Extension specific connection error | CONNECTION_ERROR: ProxyConnectionError: Failed to connect to proxy URL <url>. |
| 20 | DATA_VALIDATION_ERROR | Input fields validation error | DATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDERR for more details. |
| 21 | FAIL | User Stopped the execution | FAIL: Job Run started successfully but resulted in status STOPPED. |
Extension Output
In the context of a workflow, subsequent tasks can rely on the information provided by this integration as Extension Output.
...
result section includes the following attributes.
| Attribute | Type | Description |
|---|---|---|
| out_job_run_id | string | ID of the started job run |
| job_run_status Introduced in version 1.2.0 | text | Status of the job run. Generated for Action "Start Job Run" with Wait for Success or Failure = "True". |
| started_on Introduced in version 1.2.0 | text | The date and time at which this job run was started. Generated for Action "Start Job Run" with Wait for Success or Failure = "True". |
| last_modified_on Introduced in version 1.2.0 | text | The last time that this job run was modified. Generated for Action "Start Job Run" with Wait for Success or Failure = "True". |
| completed_on Introduced in version 1.2.0 | text | The date and time that this job run completed. Generated for Action "Start Job Run" with Wait for Success or Failure = "True". |
| error_message Introduced in version 1.2.0 | text | An error message associated with this job run. Generated for Action "Start Job Run" with Wait for Success or Failure = "True". |
An example of the Extension Output with Wait for Success or Failure = "False" for a successful triggering job is presented below.
...
This document references the following documents:
| Document Link | Description |
|---|---|
| Universal Templates | User documentation for creating, working with and understanding Universal Templates and Integrations. |
| Universal Tasks | User documentation for creating Universal Tasks in the Universal Controller user interface. |
| Credentials | User documentation for creating and working with credentials. |
| Resolvable Credentials Permitted Property | User documentation for Resolvable Credentials Permitted Property. |
Changelog
ue-aws-glue-1.2.0 (2022-11-11)
...