AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Glue CreateJob API operation.

Syntax

New-GLUEJob
-Command <JobCommand>
-Connections_Connection <String[]>
-DefaultArgument <Hashtable>
-Description <String>
-GlueVersion <String>
-LogUri <String>
-MaxCapacity <Double>
-ExecutionProperty_MaxConcurrentRun <Int32>
-MaxRetry <Int32>
-Name <String>
-NotificationProperty_NotifyDelayAfter <Int32>
-NumberOfWorker <Int32>
-Role <String>
-SecurityConfiguration <String>
-Tag <Hashtable>
-Timeout <Int32>
-WorkerType <WorkerType>
-AllocatedCapacity <Int32>
-Force <SwitchParameter>

Description

Creates a new job definition.

Parameters

-AllocatedCapacity <Int32>
This parameter is deprecated. Use MaxCapacity instead.The number of AWS Glue data processing units (DPUs) to allocate to this Job. You can allocate from 2 to 100 DPUs; 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.This parameter is deprecated.
Required?False
Position?Named
Accept pipeline input?False
-Command <JobCommand>
The JobCommand that executes this job.
Required?False
Position?1
Accept pipeline input?True (ByValue, )
-Connections_Connection <String[]>
A list of connections used by the job.
Required?False
Position?Named
Accept pipeline input?False
AliasesConnections_Connections
-DefaultArgument <Hashtable>
The default arguments for this job.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.
Required?False
Position?Named
Accept pipeline input?False
AliasesDefaultArguments
-Description <String>
Description of the job being defined.
Required?False
Position?Named
Accept pipeline input?False
-ExecutionProperty_MaxConcurrentRun <Int32>
The maximum number of concurrent runs allowed for the job. The default is 1. An error is returned when this threshold is reached. The maximum value you can specify is controlled by a service limit.
Required?False
Position?Named
Accept pipeline input?False
AliasesExecutionProperty_MaxConcurrentRuns
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?False
-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.
Required?False
Position?Named
Accept pipeline input?False
-LogUri <String>
This field is reserved for future use.
Required?False
Position?Named
Accept pipeline input?False
-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.
Required?False
Position?Named
Accept pipeline input?False
-MaxRetry <Int32>
The maximum number of times to retry this job if it fails.
Required?False
Position?Named
Accept pipeline input?False
AliasesMaxRetries
-Name <String>
The name you assign to this job definition. It must be unique in your account.
Required?False
Position?Named
Accept pipeline input?False
-NotificationProperty_NotifyDelayAfter <Int32>
After a job run starts, the number of minutes to wait before sending a job run delay notification.
Required?False
Position?Named
Accept pipeline input?False
-NumberOfWorker <Int32>
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.
Required?False
Position?Named
Accept pipeline input?False
AliasesNumberOfWorkers
-Role <String>
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
Required?False
Position?Named
Accept pipeline input?False
-SecurityConfiguration <String>
The name of the SecurityConfiguration structure to be used with this job.
Required?False
Position?Named
Accept pipeline input?False
-Tag <Hashtable>
The tags to use with this job. You may use tags to limit access to the job. For more information about tags in AWS Glue, see AWS Tags in AWS Glue in the developer guide.
Required?False
Position?Named
Accept pipeline input?False
AliasesTags
-Timeout <Int32>
The job 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).
Required?False
Position?Named
Accept pipeline input?False
-WorkerType <WorkerType>
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 maps to 1 DPU (4 vCPU, 16 GB of memory, 64 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
  • For the G.2X worker type, each worker maps to 2 DPU (8 vCPU, 32 GB of memory, 128 GB disk), and provides 1 executor per worker. We recommend this worker type for memory-intensive jobs.
Required?False
Position?Named
Accept pipeline input?False

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-ProfileLocation <String>

Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)

If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.

If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.

As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.

Required? False
Position? Named
Accept pipeline input? False
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required? False
Position? Named
Accept pipeline input? False
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required? False
Position? Named
Accept pipeline input? False
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required? False
Position? Named
Accept pipeline input? False
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required? False
Position? Named
Accept pipeline input? False
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
Required? False
Position? Named
Accept pipeline input? False
-EndpointUrl <String>

The endpoint to make the call against.

Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.

Required? False
Position? Named
Accept pipeline input? False

Inputs

You can pipe a JobCommand object to this cmdlet for the Command parameter.

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.Glue.Model.CreateJobResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Examples

Example 1

PS C:\> $Command = New-Object Amazon.Glue.Model.JobCommand
$Command.Name = 'glueetl'
$Command.ScriptLocation = 's3://aws-glue-scripts-000000000000-us-west-2/admin/MyTestGlueJob.py'
$Command

$Source = "source_test_table"
$Target = "target_test_table"
$Connections = $Source, $Target

$DefArgs = @{
'--TempDir' = 's3://aws-glue-temporary-000000000000-us-west-2/admin'
'--job-bookmark-option' = 'job-bookmark-disable'
'--job-language' = 'python'
}
$DefArgs

$ExecutionProp = New-Object Amazon.Glue.Model.ExecutionProperty
$ExecutionProp.MaxConcurrentRuns = 1
$ExecutionProp

$JobParams = @{
"AllocatedCapacity" = "5"
"Command" = $Command
"Connections_Connection" = $Connections
"DefaultArguments" = $DefArgs
"Description" = "This is a test"
"ExecutionProperty" = $ExecutionProp
"MaxRetries" = "1"
"Name" = "MyOregonTestGlueJob"
"Role" = "Amazon-GlueServiceRoleForSSM"
"Timeout" = "20"
}

PS C:\> New-GlueJob @JobParams
This example creates a new job in AWS Glue. The command name value is always glueetl. AWS Glue supports running job scripts written in Python or Scala. In this example, the job script (MyTestGlueJob.py) is written in Python. Python parameters are specified in the $DefArgs variable, and then passed to the PowerShell command in the DefaultArguments parameter, which accepts a hashtable. The parameters in the $JobParams variable come from the CreateJob API, documented in the Jobs (https://docs.aws.amazon.com/glue/latest/dg/aws-glue-api-jobs-job.html) topic of the AWS Glue API reference.

Supported Version

AWS Tools for PowerShell: 2.x.y.z