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 Batch RegisterJobDefinition API operation.

Syntax

Register-BATJobDefinition
-JobDefinitionName <String>
-RetryStrategy_Attempt <Int32>
-ContainerProperties_Command <String[]>
-LinuxParameters_Device <Device[]>
-ContainerProperties_Environment <KeyValuePair[]>
-ContainerProperties_Image <String>
-ContainerProperties_InstanceType <String>
-ContainerProperties_JobRoleArn <String>
-NodeProperties_MainNode <Int32>
-ContainerProperties_Memory <Int32>
-ContainerProperties_MountPoint <MountPoint[]>
-NodeProperties_NodeRangeProperty <NodeRangeProperty[]>
-NodeProperties_NumNode <Int32>
-Parameter <Hashtable>
-ContainerProperties_Privileged <Boolean>
-ContainerProperties_ReadonlyRootFilesystem <Boolean>
-ContainerProperties_ResourceRequirement <ResourceRequirement[]>
-Timeout <JobTimeout>
-Type <JobDefinitionType>
-ContainerProperties_Ulimit <Ulimit[]>
-ContainerProperties_User <String>
-ContainerProperties_Vcpus <Int32>
-ContainerProperties_Volume <Volume[]>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Registers an AWS Batch job definition.

Parameters

-ContainerProperties_Command <String[]>
The command that is passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_Environment <KeyValuePair[]>
The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.We do not recommend using plaintext environment variables for sensitive information, such as credential data.Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_Image <String>
The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.
  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).
  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).
  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).
  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_InstanceType <String>
The instance type to use for a multi-node parallel job. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_JobRoleArn <String>
The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_Memory <Int32>
The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job.If you are trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory Management in the AWS Batch User Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_MountPoint <MountPoint[]>
The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerProperties_MountPoints
-ContainerProperties_Privileged <Boolean>
When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_ReadonlyRootFilesystem <Boolean>
When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_ResourceRequirement <ResourceRequirement[]>
The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerProperties_ResourceRequirements
-ContainerProperties_Ulimit <Ulimit[]>
A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerProperties_Ulimits
-ContainerProperties_User <String>
The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_Vcpus <Int32>
The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ContainerProperties_Volume <Volume[]>
A list of data volumes used in a job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerProperties_Volumes
-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?True (ByPropertyName)
-JobDefinitionName <String>
The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-LinuxParameters_Device <Device[]>
Any host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesContainerProperties_LinuxParameters_Devices
-NodeProperties_MainNode <Int32>
Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NodeProperties_NodeRangeProperty <NodeRangeProperty[]>
A list of node ranges and their properties associated with a multi-node parallel job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNodeProperties_NodeRangeProperties
-NodeProperties_NumNode <Int32>
The number of nodes associated with a multi-node parallel job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNodeProperties_NumNodes
-Parameter <Hashtable>
Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesParameters
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the JobDefinitionName parameter. The -PassThru parameter is deprecated, use -Select '^JobDefinitionName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-RetryStrategy_Attempt <Int32>
The number of times to move a job to the RUNNABLE status. You may specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRetryStrategy_Attempts
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Batch.Model.RegisterJobDefinitionResponse). Specifying the name of a property of type Amazon.Batch.Model.RegisterJobDefinitionResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Timeout <JobTimeout>
The timeout configuration for jobs that are submitted with this job definition, after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that is specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Type <JobDefinitionType>
The type of job definition.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)

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?True (ByPropertyName)
AliasesAK
-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?True (ByValue, ByPropertyName)
-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?True (ByPropertyName)
-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?True (ByValue, ByPropertyName)
-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.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?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-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?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-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?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

Amazon.Batch.Model.RegisterJobDefinitionResponse
This cmdlet returns an Amazon.Batch.Model.RegisterJobDefinitionResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
AWS Tools for PowerShell User Guide

Supported Version

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