describe-enrichment-job¶

Description¶

Retrieves detailed information about a specific enrichment job, including its current status, configuration, and timestamps.

Use Cases

Monitor job progress by checking status updates with DescribeEnrichmentJob
Retrieve the complete job configuration submitted during creation
Debug failed jobs by examining the failureMessage field
Track job lifecycle with creation, update, completion, and cancellation timestamps

Status Monitoring

Jobs progress through statuses: PENDING → RUNNING → terminal state

Terminal states:

COMPLETED: Job finished successfully; query IoT SiteWise for semantic search results
FAILED: Job encountered an error; check failureMessage for details
TIMED_OUT: Job exceeded maximum processing time
CANCELLED: Job was cancelled via CancelEnrichmentJob

Response Fields

The response includes:

Current job status and type
Full job configuration as originally submitted
Lifecycle timestamps (created, updated, completed, cancelled)
Failure details if status is FAILED

Synopsis¶

  describe-enrichment-job
--workspace-name <value>
--job-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--workspace-name (string) [required]

The name of the IoT SiteWise workspace containing the enrichment job.

Constraints:

min: 1

max: 64

pattern: ^[a-zA-Z0-9_-]+$

--job-id (string) [required]

The unique identifier of the enrichment job to retrieve. This is the jobId returned by CreateEnrichmentJob.

Constraints:

min: 36

max: 36

pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

jobId -> (string)

The unique identifier of the enrichment job.

Constraints:

min: 36

max: 36

pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

status -> (string)

Current status of the enrichment job. Possible values:

PENDING: Job is waiting to start processing

RUNNING: Job is actively processing video data

COMPLETED: Job finished successfully; embeddings available in IoT SiteWise

FAILED: Job encountered an error; see failureMessage for details

TIMED_OUT: Job exceeded maximum processing time limit

CANCELLED: Job was cancelled by user request

Possible values:

PENDING

RUNNING

COMPLETED

FAILED

TIMED_OUT

CANCELLED

workspaceName -> (string)

The name of the IoT SiteWise workspace containing the job.

Constraints:

min: 1

max: 64

pattern: ^[a-zA-Z0-9_-]+$

jobType -> (string)

The type of enrichment job, derived from the job configuration. Currently EVENT_DETECTION is the only supported type.

Possible values:

EVENT_DETECTION

jobConfiguration -> (tagged union structure)

The complete job configuration as originally submitted, including the analysis type and parameters. For event detection jobs, this includes the dataset ID, time series identifier, and trim settings defining the analysis time range.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: eventDetection.

eventDetection -> (structure)

Event detection configuration that generates embeddings from video time-series data enabling natural language similarity search on events. The service processes video data and creates embeddings stored in IoT SiteWise for semantic querying.

datasetId -> (string) [required]

The IoT SiteWise dataset ID containing the video time-series data to analyze. Query IoT SiteWise to discover available datasets in your workspace.

Constraints:

min: 36

max: 36

pattern: ^(?!00000000-0000-0000-0000-000000000000)[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

timeSeriesId -> (string)

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.

Constraints:

min: 36

max: 73

propertyAlias -> (string)

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.

Constraints:

min: 1

max: 2048

pattern: [^\u0000-\u001F\u007F]+

trimSettings -> (structure) [required]

Time range settings defining which portion of the video time-series data to process. Required to ensure predictable processing time and prevent analyzing unbounded datasets. Start and end times must be within the dataset’s time bounds.

startTime -> (structure) [required]

Start time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or after this time are included in the enrichment. Must be within the dataset’s time bounds. Example (JavaScript): Date.parse(‘2024-01-01T00:00:00Z’) * 1000000 Example (Python): int(datetime.timestamp() * 1e9)

timeInSeconds -> (long) [required]

The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

Constraints:

min: 1

max: 9223372036854774

offsetInNanos -> (integer)

The nanosecond offset from timeInSeconds .

Constraints:

min: 0

max: 999999999

endTime -> (structure) [required]

End time for the video analysis time range in nanoseconds since Unix epoch (TimeInNanos format). Data segments at or before this time are included in the enrichment. Must be greater than startTime and within the dataset’s time bounds.

timeInSeconds -> (long) [required]

The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided by offsetInNanos .

Constraints:

min: 1

max: 9223372036854774

offsetInNanos -> (integer)

The nanosecond offset from timeInSeconds .

Constraints:

min: 0

max: 999999999

createdAt -> (timestamp)

Timestamp when the enrichment job was created in ISO 8601 format.

updatedAt -> (timestamp)

Timestamp when the job status was last updated in ISO 8601 format. Useful for tracking recent activity.

completedAt -> (timestamp)

Timestamp when the job completed successfully in ISO 8601 format. Only present if status is COMPLETED.

cancelledAt -> (timestamp)

Timestamp when the job was cancelled in ISO 8601 format. Only present if status is CANCELLED.

failureMessage -> (string)

Human-readable error message explaining why the job failed. Only present if status is FAILED. Use this information to diagnose configuration issues, permission problems, or data processing errors.

Table of Contents

Feedback

User Guide