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 IoT CreateJob API operation.

Syntax

New-IOTJob
-JobId <String>
-AbortConfig_CriteriaList <AbortCriteria[]>
-JobExecutionsRetryConfig_CriteriaList <RetryCriteria[]>
-Description <String>
-DestinationPackageVersion <String[]>
-Document <String>
-DocumentParameter <Hashtable>
-DocumentSource <String>
-SchedulingConfig_EndBehavior <JobEndBehavior>
-SchedulingConfig_EndTime <String>
-PresignedUrlConfig_ExpiresInSec <Int64>
-JobExecutionsRolloutConfig_ExponentialRate <ExponentialRolloutRate>
-TimeoutConfig_InProgressTimeoutInMinute <Int64>
-JobTemplateArn <String>
-SchedulingConfig_MaintenanceWindow <MaintenanceWindow[]>
-JobExecutionsRolloutConfig_MaximumPerMinute <Int32>
-NamespaceId <String>
-PresignedUrlConfig_RoleArn <String>
-SchedulingConfig_StartTime <String>
-Tag <Tag[]>
-Target <String[]>
-TargetSelection <TargetSelection>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTConfig>

Description

Creates a job. Requires permission to access the CreateJob action.

Parameters

-AbortConfig_CriteriaList <AbortCriteria[]>
The list of criteria that determine when and how to abort the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientConfig <AmazonIoTConfig>
Amazon.PowerShell.Cmdlets.IOT.AmazonIoTClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
A short text description of the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DestinationPackageVersion <String[]>
The package version Amazon Resource Names (ARNs) that are installed on the device when the job successfully completes. The package version must be in either the Published or Deprecated state when the job deploys. For more information, see Package version lifecycle. Note:The following Length Constraints relates to a single ARN. Up to 25 package version ARNs are allowed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDestinationPackageVersions
-Document <String>
The job document. Required if you don't specify a value for documentSource.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DocumentParameter <Hashtable>
Parameters of an Amazon Web Services managed template that you can specify to create the job document.documentParameters can only be used when creating jobs from Amazon Web Services managed templates. This parameter can't be used with custom job templates or to create jobs from them.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDocumentParameters
-DocumentSource <String>
An S3 link, or S3 object URL, to the job document. The link is an Amazon S3 object URL and is required if you don't specify a value for document.For example, --document-source https://s3.region-code.amazonaws.com/example-firmware/device-firmware.1.0For more information, see Methods for accessing a bucket.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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)
-JobExecutionsRetryConfig_CriteriaList <RetryCriteria[]>
The list of criteria that determines how many retries are allowed for each failure type for a job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobExecutionsRolloutConfig_ExponentialRate <ExponentialRolloutRate>
The rate of increase for a job rollout. This parameter allows you to define an exponential rate for a job rollout.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobExecutionsRolloutConfig_MaximumPerMinute <Int32>
The maximum number of things that will be notified of a pending job, per minute. This parameter allows you to create a staged rollout.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobId <String>
A job identifier which must be unique for your Amazon Web Services account. We recommend using a UUID. Alpha-numeric characters, "-" and "_" are valid for use here.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-JobTemplateArn <String>
The ARN of the job template used to create the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NamespaceId <String>
The namespace used to indicate that a job is a customer-managed job.When you specify a value for this parameter, Amazon Web Services IoT Core sends jobs notifications to MQTT topics that contain the value in the following format.$aws/things/THING_NAME/jobs/JOB_ID/notify-namespace-NAMESPACE_ID/The namespaceId feature is only supported by IoT Greengrass at this time. For more information, see Setting up IoT Greengrass core devices.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the JobId parameter. The -PassThru parameter is deprecated, use -Select '^JobId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PresignedUrlConfig_ExpiresInSec <Int64>
How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 3600 seconds. Pre-signed URLs are generated when Jobs receives an MQTT request for the job document.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PresignedUrlConfig_RoleArn <String>
The ARN of an IAM role that grants permission to download files from the S3 bucket where the job data/updates are stored. The role must also grant permission for IoT to download the files.For information about addressing the confused deputy problem, see cross-service confused deputy prevention in the Amazon Web Services IoT Core developer guide.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfig_EndBehavior <JobEndBehavior>
Specifies the end behavior for all job executions after a job reaches the selected endTime. If endTime is not selected when creating the job, then endBehavior does not apply.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfig_EndTime <String>
The time a job will stop rollout of the job document to all devices in the target group for a job. The endTime must take place no later than two years from the current time and be scheduled a minimum of thirty minutes from the current time. The minimum duration between startTime and endTime is thirty minutes. The maximum duration between startTime and endTime is two years. The date and time format for the endTime is YYYY-MM-DD for the date and HH:MM for the time.For more information on the syntax for endTime when using an API command or the Command Line Interface, see Timestamp.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SchedulingConfig_MaintenanceWindow <MaintenanceWindow[]>
An optional configuration within the SchedulingConfig to setup a recurring maintenance window with a predetermined start time and duration for the rollout of a job document to all devices in a target group for a job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSchedulingConfig_MaintenanceWindows
-SchedulingConfig_StartTime <String>
The time a job will begin rollout of the job document to all devices in the target group for a job. The startTime can be scheduled up to a year in advance and must be scheduled a minimum of thirty minutes from the current time. The date and time format for the startTime is YYYY-MM-DD for the date and HH:MM for the time.For more information on the syntax for startTime when using an API command or the Command Line Interface, see Timestamp.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-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.IoT.Model.CreateJobResponse). Specifying the name of a property of type Amazon.IoT.Model.CreateJobResponse 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)
-Tag <Tag[]>
Metadata which can be used to manage the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Target <String[]>
A list of things and thing groups to which the job should be sent.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargets
-TargetSelection <TargetSelection>
Specifies whether the job will continue to run (CONTINUOUS), or will be complete after all those things specified as targets have completed the job (SNAPSHOT). If continuous, the job may also be run on a thing when a change is detected in a target. For example, a job will run on a thing when the thing is added to a target group, even after the job was completed by all things originally in the group.We recommend that you use continuous jobs instead of snapshot jobs for dynamic thing group targets. By using continuous jobs, devices that join the group receive the job execution even after the job has been created.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeoutConfig_InProgressTimeoutInMinute <Int64>
Specifies the amount of time, in minutes, this device has to finish execution of this job. The timeout interval can be anywhere between 1 minute and 7 days (1 to 10080 minutes). The in progress timer can't be updated and will apply to all job executions for the job. Whenever a job execution remains in the IN_PROGRESS status for longer than this interval, the job execution will fail and switch to the terminal TIMED_OUT status.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTimeoutConfig_InProgressTimeoutInMinutes

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.IoT.Model.CreateJobResponse
This cmdlet returns an Amazon.IoT.Model.CreateJobResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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