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 FleetWise CreateCampaign API operation.

Syntax

New-IFWCampaign
-Name <String>
-Compression <Compression>
-ConditionBasedCollectionScheme_ConditionLanguageVersion <Int32>
-DataDestinationConfig <DataDestinationConfig[]>
-DataExtraDimension <String[]>
-Description <String>
-DiagnosticsMode <DiagnosticsMode>
-ExpiryTime <DateTime>
-ConditionBasedCollectionScheme_Expression <String>
-ConditionBasedCollectionScheme_MinimumTriggerIntervalMs <Int64>
-TimeBasedCollectionScheme_PeriodMs <Int64>
-PostTriggerCollectionDuration <Int64>
-SignalCatalogArn <String>
-SignalsToCollect <SignalInformation[]>
-SpoolingMode <SpoolingMode>
-StartTime <DateTime>
-Tag <Tag[]>
-TargetArn <String>
-ConditionBasedCollectionScheme_TriggerMode <TriggerMode>
-Priority <Int32>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTFleetWiseConfig>

Description

Creates an orchestration of data collection rules. The Amazon Web Services IoT FleetWise Edge Agent software running in vehicles uses campaigns to decide how to collect and transfer data to the cloud. You create campaigns in the cloud. After you or your team approve campaigns, Amazon Web Services IoT FleetWise automatically deploys them to vehicles. For more information, see Collect and transfer data with campaigns in the Amazon Web Services IoT FleetWise Developer Guide.

Parameters

-ClientConfig <AmazonIoTFleetWiseConfig>
Amazon.PowerShell.Cmdlets.IFW.AmazonIoTFleetWiseClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Compression <Compression>
(Optional) Whether to compress signals before transmitting data to Amazon Web Services IoT FleetWise. If you don't want to compress the signals, use OFF. If it's not specified, SNAPPY is used. Default: SNAPPY
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConditionBasedCollectionScheme_ConditionLanguageVersion <Int32>
Specifies the version of the conditional expression language.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCollectionScheme_ConditionBasedCollectionScheme_ConditionLanguageVersion
-ConditionBasedCollectionScheme_Expression <String>
The logical expression used to recognize what data to collect. For example, $variable.`Vehicle.OutsideAirTemperature` >= 105.0.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCollectionScheme_ConditionBasedCollectionScheme_Expression
-ConditionBasedCollectionScheme_MinimumTriggerIntervalMs <Int64>
The minimum duration of time between two triggering events to collect data, in milliseconds.If a signal changes often, you might want to collect data at a slower rate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCollectionScheme_ConditionBasedCollectionScheme_MinimumTriggerIntervalMs
-ConditionBasedCollectionScheme_TriggerMode <TriggerMode>
Whether to collect data for all triggering events (ALWAYS). Specify (RISING_EDGE), or specify only when the condition first evaluates to false. For example, triggering on "AirbagDeployed"; Users aren't interested on triggering when the airbag is already exploded; they only care about the change from not deployed => deployed.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCollectionScheme_ConditionBasedCollectionScheme_TriggerMode
-DataDestinationConfig <DataDestinationConfig[]>
The destination where the campaign sends data. You can choose to send data to be stored in Amazon S3 or Amazon Timestream.Amazon S3 optimizes the cost of data storage and provides additional mechanisms to use vehicle data, such as data lakes, centralized data storage, data processing pipelines, and analytics. Amazon Web Services IoT FleetWise supports at-least-once file delivery to S3. Your vehicle data is stored on multiple Amazon Web Services IoT FleetWise servers for redundancy and high availability.You can use Amazon Timestream to access and analyze time series data, and Timestream to query vehicle data so that you can identify trends and patterns.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataDestinationConfigs
-DataExtraDimension <String[]>
(Optional) A list of vehicle attributes to associate with a campaign. Enrich the data with specified vehicle attributes. For example, add make and model to the campaign, and Amazon Web Services IoT FleetWise will associate the data with those attributes as dimensions in Amazon Timestream. You can then query the data against make and model.Default: An empty array
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesDataExtraDimensions
-Description <String>
An optional description of the campaign to help identify its purpose.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-DiagnosticsMode <DiagnosticsMode>
(Optional) Option for a vehicle to send diagnostic trouble codes to Amazon Web Services IoT FleetWise. If you want to send diagnostic trouble codes, use SEND_ACTIVE_DTCS. If it's not specified, OFF is used.Default: OFF
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ExpiryTime <DateTime>
(Optional) The time the campaign expires, in seconds since epoch (January 1, 1970 at midnight UTC time). Vehicle data isn't collected after the campaign expires. Default: 253402214400 (December 31, 9999, 00:00:00 UTC)
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)
-Name <String>
The name of the campaign to create.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the Name parameter. The -PassThru parameter is deprecated, use -Select '^Name' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-PostTriggerCollectionDuration <Int64>
(Optional) How long (in milliseconds) to collect raw data after a triggering event initiates the collection. If it's not specified, 0 is used.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Priority <Int32>
(Optional) A number indicating the priority of one campaign over another campaign for a certain vehicle or fleet. A campaign with the lowest value is deployed to vehicles before any other campaigns. If it's not specified, 0 is used. Default: 0This parameter is deprecated.
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.IoTFleetWise.Model.CreateCampaignResponse). Specifying the name of a property of type Amazon.IoTFleetWise.Model.CreateCampaignResponse 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)
-SignalCatalogArn <String>
The Amazon Resource Name (ARN) of the signal catalog to associate with the campaign.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-SignalsToCollect <SignalInformation[]>
(Optional) A list of information about signals to collect.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SpoolingMode <SpoolingMode>
(Optional) Whether to store collected data after a vehicle lost a connection with the cloud. After a connection is re-established, the data is automatically forwarded to Amazon Web Services IoT FleetWise. If you want to store collected data when a vehicle loses connection with the cloud, use TO_DISK. If it's not specified, OFF is used.Default: OFF
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-StartTime <DateTime>
(Optional) The time, in milliseconds, to deliver a campaign after it was approved. If it's not specified, 0 is used.Default: 0
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Tag[]>
Metadata that can be used to manage the campaign.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-TargetArn <String>
The ARN of the vehicle or fleet to deploy a campaign to.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-TimeBasedCollectionScheme_PeriodMs <Int64>
The time period (in milliseconds) to decide how often to collect data. For example, if the time period is 60000, the Edge Agent software collects data once every minute.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesCollectionScheme_TimeBasedCollectionScheme_PeriodMs

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.IoTFleetWise.Model.CreateCampaignResponse
This cmdlet returns an Amazon.IoTFleetWise.Model.CreateCampaignResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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