Versions Compared

Key

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

...

Template NameExtension NameExtension Version
AWS Glueue-aws-glue1.2.01

Refer to Changelog for version history information.

...

  • Universal Agent for Windows x64 Version 7.02.0.0 and later with python options installed.
  • Universal Agent for Linux Version 7.02.0.0 and later with python options installed.

...

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 TypeOptionalNoneChoiceType of predefined worker that is allocated when a job runs. Available options are the following.

  • Standard
  • G.1X
  • G.2X
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".

...

{
    "exit_code": 0,
    "status_description": "SUCCESS: AWS Glue Job started successfully.",
    "changed": true,
    "invocation": {
        "extension": "ue-aws-glue",
        "version": "1.2.01",
        "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": null,
            "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": [
                {
                    "--sleep": "0"
                },
                {
                    "--JOB_NAME": "Glue_Job"
                }
            ]
        }
    },
    "result": {
        "out_job_run_id": "jr_123456789"
    }
}

...

{
    "exit_code": 0,
    "status_description": "SUCCESS: AWS Glue Job started successfully and resulted in status SUCCEEDED.",
    "changed": true,
    "invocation": {
        "extension": "ue-aws-glue",
        "version": "1.2.01",
        "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": null,
            "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": 3,
            "input_arguments_source": "script_field",
            "input_arguments_script": {
                "--JOB_NAME": "Glue_Job"
            },
            "input_arguments": []
        }
    },
    "result": {
        "job_run_id": "jr_123456789",
        "job_run_status": "SUCCEEDED",
        "started_on": "2022-09-13 11:06:34.360000+03:00",
        "last_modified_on": "2022-09-13 11:07:41.514000+03:00",
        "completed_on": "2022-09-13 11:07:41.514000+03:00",
        "error_message": null
    }
}

...

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-1.2.1 (2023-12-21)

Enhancements

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

Enhancements

  • Added: Support Start Glue Job and Wait until Job Reaches status "Succeeded" or "Failed" (#30157)
  • Added: Larger set of output fields (#30157)
  • Added: Log payload response for Job Run Status and Start Glue Job Run Action on debug mode.
  • Added: Option to pass Input Arguments as UAC script supporting UAC environment variables and UAC Functions.

ue-aws-glue-1.2.0 (2022-11-11)

Enhancements

  • Added: Support Start Glue Job and Wait until Job Reaches status "Succeeded" or "Failed" (#30157)
  • Added: Larger set of output fields (#30157)
  • Added: Log payload response for Job Run Status and Start Glue Job Run Action on debug mode.
  • Added: Option to pass Input Arguments as UAC script supporting UAC environment variables and UAC Functions.

ue-aws-glue-1.1.0 (2022-06-23)

Enhancements

  • Added: Allow AWS Credentials and AWS Region as optional fields enabling their configuration on the task execution environment. (#28312)

...