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 Managed integrations for AWS IoT Device Management CreateOtaTask API operation.

Syntax

New-IOTMIOtaTask
-Description <String>
-OtaSchedulingConfig_EndBehavior <SchedulingConfigEndBehavior>
-OtaSchedulingConfig_EndTime <String>
-OtaSchedulingConfig_MaintenanceWindow <ScheduleMaintenanceWindow[]>
-OtaMechanism <OtaMechanism>
-OtaTargetQueryString <String>
-OtaType <OtaType>
-Protocol <OtaProtocol>
-OtaTaskExecutionRetryConfig_RetryConfigCriterion <RetryConfigCriteria[]>
-S3Url <String>
-OtaSchedulingConfig_StartTime <String>
-Tag <Hashtable>
-Target <String[]>
-TaskConfigurationId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTManagedIntegrationsConfig>

Description

Create an over-the-air (OTA) task to target a device.

Parameters

-ClientConfig <AmazonIoTManagedIntegrationsConfig>
Amazon.PowerShell.Cmdlets.IOTMI.AmazonIoTManagedIntegrationsClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
An idempotency token. If you retry a request that completed successfully initially using the same client token and parameters, then the retry attempt will succeed without performing any further actions.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Description <String>
The description of the over-the-air (OTA) task.
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)
-OtaMechanism <OtaMechanism>
The deployment mechanism for the over-the-air (OTA) task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OtaSchedulingConfig_EndBehavior <SchedulingConfigEndBehavior>
Specifies the end behavior for all task executions after a task reaches the selected endTime. If endTime is not selected when creating the task, then endBehavior does not apply.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OtaSchedulingConfig_EndTime <String>
The time an over-the-air (OTA) task will stop.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OtaSchedulingConfig_MaintenanceWindow <ScheduleMaintenanceWindow[]>
Maintenance window list for over-the-air (OTA) task scheduling config.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOtaSchedulingConfig_MaintenanceWindows
-OtaSchedulingConfig_StartTime <String>
The time an over-the-air (OTA) task will start.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OtaTargetQueryString <String>
The query string to add things to the thing group.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-OtaTaskExecutionRetryConfig_RetryConfigCriterion <RetryConfigCriteria[]>
The list of retry config criteria.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOtaTaskExecutionRetryConfig_RetryConfigCriteria
-OtaType <OtaType>
The frequency type for the over-the-air (OTA) task.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Protocol <OtaProtocol>
The connection protocol the over-the-air (OTA) task uses to update the device.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-S3Url <String>
The URL to the Amazon S3 bucket where the over-the-air (OTA) task is stored.
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.IoTManagedIntegrations.Model.CreateOtaTaskResponse). Specifying the name of a property of type Amazon.IoTManagedIntegrations.Model.CreateOtaTaskResponse 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 <Hashtable>
A set of key/value pairs that are used to manage the over-the-air (OTA) task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Target <String[]>
The device targeted for the over-the-air (OTA) task.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-TaskConfigurationId <String>
The identifier for the over-the-air (OTA) task configuration.
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.IoTManagedIntegrations.Model.CreateOtaTaskResponse
This cmdlet returns an Amazon.IoTManagedIntegrations.Model.CreateOtaTaskResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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