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 CreateOTAUpdate API operation.

Syntax

New-IOTOTAUpdate
-OtaUpdateId <String>
-AwsJobAbortConfig_AbortCriteriaList <AwsJobAbortCriteria[]>
-AdditionalParameter <Hashtable>
-ExponentialRate_BaseRatePerMinute <Int32>
-Description <String>
-AwsJobPresignedUrlConfig_ExpiresInSec <Int64>
-File <OTAUpdateFile[]>
-ExponentialRate_IncrementFactor <Double>
-AwsJobTimeoutConfig_InProgressTimeoutInMinute <Int64>
-AwsJobExecutionsRolloutConfig_MaximumPerMinute <Int32>
-RateIncreaseCriteria_NumberOfNotifiedThing <Int32>
-RateIncreaseCriteria_NumberOfSucceededThing <Int32>
-Protocol <String[]>
-RoleArn <String>
-Tag <Tag[]>
-Target <String[]>
-TargetSelection <TargetSelection>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTConfig>

Description

Creates an IoT OTA update on a target group of things or groups. Requires permission to access the CreateOTAUpdate action.

Parameters

-AdditionalParameter <Hashtable>
A list of additional OTA update parameters, which are name-value pairs. They won't be sent to devices as a part of the Job document.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAdditionalParameters
-AwsJobAbortConfig_AbortCriteriaList <AwsJobAbortCriteria[]>
The list of criteria that determine when and how to abort the job.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsJobExecutionsRolloutConfig_MaximumPerMinute <Int32>
The maximum number of OTA update job executions started per minute.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsJobPresignedUrlConfig_ExpiresInSec <Int64>
How long (in seconds) pre-signed URLs are valid. Valid values are 60 - 3600, the default value is 1800 seconds. Pre-signed URLs are generated when a request for the job document is received.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-AwsJobTimeoutConfig_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)
AliasesAwsJobTimeoutConfig_InProgressTimeoutInMinutes
-ClientConfig <AmazonIoTConfig>
Amazon.PowerShell.Cmdlets.IOT.AmazonIoTClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the OTA update.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExponentialRate_BaseRatePerMinute <Int32>
The minimum number of things that will be notified of a pending job, per minute, at the start of the job rollout. This is the initial rate of the rollout.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsJobExecutionsRolloutConfig_ExponentialRate_BaseRatePerMinute
-ExponentialRate_IncrementFactor <Double>
The rate of increase for a job rollout. The number of things notified is multiplied by this factor.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsJobExecutionsRolloutConfig_ExponentialRate_IncrementFactor
-File <OTAUpdateFile[]>
The files to be streamed by the OTA update.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesFiles
-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)
-OtaUpdateId <String>
The ID of the OTA update to be created.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the OtaUpdateId parameter. The -PassThru parameter is deprecated, use -Select '^OtaUpdateId' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol <String[]>
The protocol used to transfer the OTA update image. Valid values are [HTTP], [MQTT], [HTTP, MQTT]. When both HTTP and MQTT are specified, the target device can choose the protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesProtocols
-RateIncreaseCriteria_NumberOfNotifiedThing <Int32>
When this number of things have been notified, it will initiate an increase in the rollout rate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsJobExecutionsRolloutConfig_ExponentialRate_RateIncreaseCriteria_NumberOfNotifiedThings
-RateIncreaseCriteria_NumberOfSucceededThing <Int32>
When this number of things have succeeded in their job execution, it will initiate an increase in the rollout rate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAwsJobExecutionsRolloutConfig_ExponentialRate_RateIncreaseCriteria_NumberOfSucceededThings
-RoleArn <String>
The IAM role that grants Amazon Web Services IoT Core access to the Amazon S3, IoT jobs and Amazon Web Services Code Signing resources to create an OTA update job.
Required?True
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.CreateOTAUpdateResponse). Specifying the name of a property of type Amazon.IoT.Model.CreateOTAUpdateResponse 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 updates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Target <String[]>
The devices targeted to receive OTA updates.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTargets
-TargetSelection <TargetSelection>
Specifies whether the update will continue to run (CONTINUOUS), or will be complete after all the things specified as targets have completed the update (SNAPSHOT). If continuous, the update may also be run on a thing when a change is detected in a target. For example, an update will run on a thing when the thing is added to a target group, even after the update was completed by all things originally in the group. Valid values: CONTINUOUS | SNAPSHOT.
Required?False
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.IoT.Model.CreateOTAUpdateResponse
This cmdlet returns an Amazon.IoT.Model.CreateOTAUpdateResponse 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