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 SiteWise CreateEnrichmentJob API operation.

Syntax

New-IOTSWEnrichmentJob
-WorkspaceName <String>
-JobConfiguration_EventDetection_DatasetId <String>
-JobConfiguration_EventDetection_TrimSettings_EndTime_OffsetInNano <Int32>
-JobConfiguration_EventDetection_TrimSettings_StartTime_OffsetInNano <Int32>
-JobConfiguration_EventDetection_PropertyAlias <String>
-JobConfiguration_EventDetection_TrimSettings_EndTime_TimeInSecond <Int64>
-JobConfiguration_EventDetection_TrimSettings_StartTime_TimeInSecond <Int64>
-JobConfiguration_EventDetection_TimeSeriesId <String>
-ClientToken <String>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonIoTSiteWiseConfig>

Description

Creates an asynchronous enrichment job to analyze time-series sensor data. The operation returns immediately with job details while processing continues in the background.

Idempotency

Include a clientToken to make the operation idempotent. If you submit the same request with the same token within the idempotency window, you receive the original job details without creating a duplicate.

Prerequisites

Before creating a job, ensure:
  • The workspace is in ACTIVE state (not being deleted)
  • You have IAM permissions for the workspace, dataset, and time-series resources
  • You have KMS Decrypt permission on the workspace's customer-managed encryption key
  • No duplicate job (same workspace, dataset, property, and job type) is currently running

Workflow

  1. Submit the job with configuration specifying which video data to analyze and the time range
  2. Capture the jobId from the response
  3. Use DescribeEnrichmentJob to monitor progress and check job status
  4. When status reaches a terminal state (COMPLETED, FAILED, TIMED_OUT, CANCELLED), check results
  5. For COMPLETED jobs, query IoT SiteWise for semantic search on video events

Error Handling

  • ConflictingOperationException: A duplicate job is already running for the same configuration
  • InvalidRequestException: Invalid parameters (e.g., both timeSeriesId and propertyAlias specified)
  • AccessDeniedException: Insufficient IAM or KMS permissions
  • LimitExceededException: Too many concurrent jobs or requests

Parameters

-ClientConfig <AmazonIoTSiteWiseConfig>
Amazon.PowerShell.Cmdlets.IOTSW.AmazonIoTSiteWiseClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClientToken <String>
Optional unique token that makes the operation idempotent. If you submit the same request with the same token within the idempotency window, the service returns the original job without creating a duplicate. Use a UUID or timestamp-based token for each unique request.
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)
-JobConfiguration_EventDetection_DatasetId <String>
<p>The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.</p>
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfiguration_EventDetection_PropertyAlias <String>
<p>Human-readable alias for the video time series to analyze (e.g., /camera/warehouse/zone-a). Specify either propertyAlias or timeSeriesId, but not both. Use this when you have configured friendly aliases in IoT SiteWise for better readability.</p>
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfiguration_EventDetection_TimeSeriesId <String>
<p>Unique system identifier for the video time series to analyze. Specify either timeSeriesId or propertyAlias, but not both. Use this when you have the system-generated time series identifier from IoT SiteWise.</p>
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JobConfiguration_EventDetection_TrimSettings_EndTime_OffsetInNano <Int32>
The nanosecond offset from timeInSeconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfiguration_EventDetection_TrimSettings_EndTime_OffsetInNanos
-JobConfiguration_EventDetection_TrimSettings_EndTime_TimeInSecond <Int64>
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfiguration_EventDetection_TrimSettings_EndTime_TimeInSeconds
-JobConfiguration_EventDetection_TrimSettings_StartTime_OffsetInNano <Int32>
The nanosecond offset from timeInSeconds.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfiguration_EventDetection_TrimSettings_StartTime_OffsetInNanos
-JobConfiguration_EventDetection_TrimSettings_StartTime_TimeInSecond <Int64>
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesJobConfiguration_EventDetection_TrimSettings_StartTime_TimeInSeconds
-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.IoTSiteWise.Model.CreateEnrichmentJobResponse). Specifying the name of a property of type Amazon.IoTSiteWise.Model.CreateEnrichmentJobResponse 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)
-WorkspaceName <String>
The name of the IoT SiteWise workspace containing the video data to analyze.
Required?True
Position?1
Accept pipeline input?True (ByValue, 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.IoTSiteWise.Model.CreateEnrichmentJobResponse
This cmdlet returns an Amazon.IoTSiteWise.Model.CreateEnrichmentJobResponse object containing multiple properties.
AWS Tools for PowerShell User Guide

Supported Version

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