Versions Compared

Old Version 26

changes.mady.by.user Stonebranch

Saved on

compared with

New Version 27

changes.mady.by.user Stonebranch

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

.1
Template NameExtension NameExtension VersionStatus
AWS Glueue-aws-glue2Fixes and new Features are introduced.
AWS Glueue-aws-glue1Hot Fixes Only (Until UAC 7.2 and 7.3 are End of Support)

Refer to Changelog for version history information.

...



Note

This

...

is a major release and introduces breaking changes that might affect some customers depending on their setup. Administrators are strongly advised to refer to Changelog for more information on the changes introduced in this release.


Software Requirements

This integration requires a Universal Agent and a Python runtime to execute the Universal Task.

Software Requirements for Universal Template and Universal Task

Requires Tested with Python version 3.7.0 or higher. Tested with 6 and 3.11.6 and with the Universal Agent bundled Python distribution.

Software Requirements for Universal Agent

...

  • Universal Agent for Windows x64 Version >= 7.24.0.0 and later with python options installed.0 
  • Universal Agent for Linux Version >= 7.24.0.0 and later with python options installed.

...

  • 0 

Software Requirements for Universal Controller

Universal Controller Version >=7.04.0.0 and later.

Network and Connectivity Requirements

...

FieldInput typeDefault valueTypeDescription
ActionRequiredStart Job RunChoice

The action performed upon the task execution.

The available actions are as follows.

  • Start Job Run.
AWS Region

Optional since version 1.1.0		Optional-TextRegion 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.

  • AWS Access Key ID as "Runtime User".
  • AWS Secret Access Key as "Runtime Password".


When AWS Credentials are not populated as part of the task definition, during task execution the integration will look for AWS Credentials on the task execution environment. Refer to configuration options for more information.
Role Based AccessOptionalFalseBoolean

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 ARNOptional-TextRole 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 NameRequired-TextName of the Glue job that will be invoked.
Job Run IDOptional-TextID of a previous Job Run to retry.
Security ConfigurationOptional-TextName of the Security Configuration structure to be used with the Job Run.
Worker TypeOptional-- None --ChoiceType of predefined worker that is allocated when a job runs. Available options are the following.

  • Standard
  • G.1X
  • G.2X
  • G.4X
  • G.8X
  • G.025X

Introduced in version 2.0.0: G.4X, G.8X, G.025X 

Number Of WorkersOptional-IntegerNumber 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.

  • 299 for G.1X.
  • and 149 for G.2X.


Required when Worker Type is not None.
Job TimeoutOptional2880Integer

Job Run timeout in minutes.

Note
titleNote

The value of 2880 Minutes is the default timeout value provided by Amazon for new AWS Glue Jobs. It is suggested that users tune this parameter to the minimum value to avoid having running jobs for more than expected.

For more information please refer to Amazon AWS Glue pricing guide.


Notify Delay PeriodOptional-IntegerAfter a job run starts, the number of minutes to wait before sending a job run delay notification.

Anchor
input_arg
input_arg
Input Arguments Source

Introduced in version 1.2.0

RequiredArray FieldChoiceSource 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-ScriptJob 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".
Input ArgumentsOptional-ArrayJob 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		OptionalFalseBooleanIf 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		Optional60IntegerThe polling interval in seconds between checking for the Job status.
Required when Wait for Success or Failure ="True".
Proxy TypeOptionalHTTPChoiceType of proxy connection to be used. Available options are the following.
  • HTTP
  • HTTPS
  • HTTPS With Credentials


Visible only when Use Proxy = "True".
ProxyOptional-Text

Comma separated list of Proxy servers.

Valid formats are the following.

http://proxyip:port or http://proxyip:port,https://proxyip:port.

Required when Use Proxy is checked.

Proxy CA Bundle FileOptional-TextThe 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 CredentialsOptional-Credentials

Credentials to be used for the proxy communication.

The credential definition should be as follows.

  • Proxy Username as "Runtime User".
  • Proxy Password as "Runtime Password".

Required when "Proxy Type" is configured for "HTTPS With Credentials".

Task Examples

Start Job Run

...

Execution Class

Introduced in version 2.0.0

Optional-- None --Choice

Indicates what execution class is used when the job is run. Available options are the following.

  • STANDARD
  • FLEX

Task Examples

Start Job Run

Start a new job run.

Image RemovedImage Added

Start Job Run with all optional input arguments

Start a new Job Run for a given Run ID (retries a previous execution), with all optional input argument.Image Removed

Image Added

Anchor
script_example
script_example
Start Job Run with all optional input arguments and script

Start a new Job Run for a given Run ID (retries a previous execution), with all optional input argument as above but use "Script" as Input Arguments Source.

Image RemovedImage Added

Job arguments in UAC Script in JSON format can pass arguments from UAC Variables or UAC Functions as shown below. More information about escaping characters for json format here.

Image RemovedImage Added

Start Job Run with Role ARN and Proxy configuration

Start a new Job Run assuming a provided ARN Role, and also using a Proxy configuration.

Image RemovedImage Added

Start Job Run with Environment Variables as Region

Start a new job run, providing no AWS Credentials in task definition and providing AWS Region as Environment Variable, leaving the respective input fields empty. AWS Credentials are expected in this case to be configured on the task execution environment. Please refer to AWS Credentials input field for more information.

Image RemovedImage Added

Task Output

Output Only Fields

The output fields for this Universal Extension are described below.

FieldTypeDescription
Job Run IDtextID of the started job run
Job Run StatustextStatus 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 CodeStatus Classification CodeStatus Classification DescriptionStatus Description
0SUCCESSSuccessful ExecutionSUCCESS: AWS Glue Job started successfully.
0SUCCESSSuccessful Execution with Wait for Success or Failure="True"SUCCESS: AWS Glue Job started successfully and resulted in status SUCCEEDED.
1FAILFailed ExecutionFAIL: < Error Description >.
1FAILFailed Execution with Wait for Success or Failure="True"FAIL: Job Run started successfully but resulted in status < STATUS >

Available values for are listed below.
  • FAILED
  • ERROR
  • TIMEOUT
2AUTHENTICATION_ERRORBad credentialsAUTHENTICATION_ERROR: Account cannot be authenticated.
3AUTHORIZATION_ERRORInsufficient PermissionsAUTHORIZATION_ERROR: Account is not authorized to perform the requested action.
10CONNECTION_ERRORBad connection data or connection timed outCONNECTION_ERROR: < Error Description >.
11CONNECTION_ERRORExtension specific connection errorCONNECTION_ERROR: ProxyConnectionError: Failed to connect to proxy URL <url>.
20DATA_VALIDATION_ERRORInput fields validation errorDATA_VALIDATION_ERROR: Some of the input fields cannot be validated. See STDERR for more details.
21FAILUser Stopped the executionFAIL: 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.

AttributeTypeDescription
out_job_run_idstringID of the started job run
job_run_status

Introduced in version 1.2.0		textStatus 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		textThe 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		textThe 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		textThe 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		textAn 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.

...


...

Code Block
languagejs
titleExtension Output with Wait for Success or Failure = "False"
collapsetrue
{
    "exit_code": 0,
    "status_description": "SUCCESS: AWS Glue Job started successfully.",
    "changed": true,
    "invocation": {
        "extension": "ue-aws-glue",
        "version": "

...

2.

...

0.

...

0",
        "fields": {
            "action": "Start Job Run",
            "aws_credentials_user": "****",
            "aws_credentials_password": "****",
            "region": "us-east-1",
            "role_based_access": false,
            "role_arn": null,
            "job_name": "AWS_Glue_pythonJob",
            "job_run_id": null,
            "security_configuration": null,
            "worker_type":

...

-- None --,
            "num_workers": null,
            "job_timeout": 2880,
            "notify_delay_period": null,
            "use_proxy": false,
            "proxy": null,
            "proxy_type": null,
            "proxy_ca_bundle_file": null,
            "proxy_credentials_user": null,
            "proxy_credentials_password": null,
            "wait_for_success_or_failure": false,
            "polling_interval": 60,
            "input_arguments_source": "array_field",
            "input_arguments_script": null,
            "input_arguments": []
            "execution_class": -- None --

...

        }

...

},

...

"

...

result": {
        "out_job_run_id": "jr_123456789"
    }
}


An example of the Extension Output with Wait for Success or Failure = "True" for a successful triggering job is presented below.job is presented below.


Code Block
languagejs
titleExtension Output with Wait for Success or Failure = "True"
collapsetrue
{
    "exit_code": 0,
    "status_description": "SUCCESS: AWS Glue Job started successfully and resulted in status SUCCEEDED.",
    "changed": true,
    "invocation": {
        "extension": "ue-aws-glue",
        "version": "

...

2.

...

0.

...

0",
        "fields": {
            "action": "Start Job Run",
            "aws_credentials_user": "****",
            "aws_credentials_password": "****",
            "region": "us-east-1",
            "role_based_access": false,
            "role_arn": null,
            "job_name": "AWS_Glue_pythonJob",
            "job_run_id": null,
            "security_configuration": null,
            "worker_type":

...

 -- None --,
            "num_workers": null,
            "job_timeout": 2880,
            "notify_delay_period": null,
            "use_proxy": false,
            "proxy": null,
            "proxy_type": null,
            "proxy_ca_bundle_file": null,
            "proxy_credentials_user": null,
            "proxy_credentials_password": null,
            "wait_for_success_or_failure": true,
            "polling_interval":

...

5,
            "input_arguments_source": "

...

array_field",
            "input_arguments_script":

...

null,

...

"input_arguments": [],
            "

...

execution_

...

class":

...

-- None --
        }
    },
    "result": {
        "job_run_id": "jr_

...

57133f7bb82f13a29fa8813d95e2b941a3c6f5f67475227e1bb8d213e888478c",
        "job_run_status": "SUCCEEDED",
        "started_on": "

...

2024-

...

03-

...

27

...

15:

...

26:

...

30.

...

998000+

...

02:00",
        "last_modified_on": "

...

2024-

...

03-

...

27

...

15:

...

26:

...

58.

...

791000+

...

02:00",
        "completed_on": "

...

2024-

...

03-

...

27

...

15:

...

26:

...

58.

...

791000+

...

02:00",
        "error_message": null
    }
}

...

STDOUT and STDERR
STDOUT and 
...
STDOUT and STDERR provide additional information to User. The populated content can STDERR provide additional information to the user.
 Warning
Backward compatibility is not guaranteed for the content of STDOUT/STDERR and can be changed in future versions 
...
 without notice
...

Extensions Cancellation and Re-Run
...
This document references the following documents:
Document LinkDescription
Universal TemplatesUser documentation for creating, working with and understanding Universal Templates and Integrations.
Universal TasksUser documentation for creating Universal Tasks in the Universal Controller user interface.
CredentialsUser documentation for creating and working with credentials.
Resolvable Credentials Permitted PropertyUser documentation for Resolvable Credentials Permitted Property.
 Anchor
changelog
changelog
Changelog
ue-aws-glue-2.0.
...
Changelog
0 (2024-04-18) 
Deprecations and Breaking Changes
  • Breaking Change: drop support for agent 7.3.X or lower, agent version 7.4.X or higher is required
Enhancements
  • Added: new input field - Execution Class
  • Added: newer worker types compatible with AWS Glue version 3, are now supported 
ue-aws-glue-1.2.1 (2023-12-21)
...
Fixes
  • Fixed: auto-renew AWS temporary credentials before expiration when using ARN based access
  • Fixed: fixed issue with polling logic where task would get stuck with status Running (#35135)
...