Note:
You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . iotsitewise ]
describe-dataset-export-job¶
Synopsis¶
describe-dataset-export-job
--workspace-name <value>
--job-id <value>
[--cli-input-json <value>]
[--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>]
[--v2-debug]
Options¶
--workspace-name (string)
The name of the workspace that contains the dataset export job.
--job-id (string)
The unique identifier for the dataset export job.
--cli-input-json (string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.
--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
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
--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.
--v2-debug (boolean)
Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.
Output¶
jobId -> (string)
The unique identifier for the dataset export job.
workspaceName -> (string)
The name of the workspace that contains the dataset export job.
status -> (string)
The current status of the dataset export job.
startedAt -> (timestamp)
The timestamp when the job started processing.
completedAt -> (timestamp)
The timestamp when the job completed, or null if the job is still running.
destinationS3Uri -> (string)
The S3 URI where output clips are written.
errorReportLocation -> (structure)
The location where the error report will be written on failure.
s3Uri -> (string)
<p>The S3 URI prefix for the error report.</p>
input -> (tagged union structure)
The processing input that was provided in the CreateDatasetExportJob request.
Note
This is a Tagged Union structure. Only one of the following top level keys can be set:timeseries,dataset.timeseries -> (list)
<p>List of individual timeseries items to process.</p>
(structure)
<p>A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.</p>
timeSeriesId -> (string)
<p>The unique identifier for the timeseries. Mutually exclusive with propertyAlias.</p>propertyAlias -> (string)
<p>The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.</p>trimSettings -> (structure)
<p>The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.</p>
startTime -> (structure)
<p>The start time for the trim range.</p>
timeInSeconds -> (long)
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided byoffsetInNanos.offsetInNanos -> (integer)
The nanosecond offset fromtimeInSeconds.endTime -> (structure)
<p>The end time for the trim range. Must be greater than startTime.</p>
timeInSeconds -> (long)
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided byoffsetInNanos.offsetInNanos -> (integer)
The nanosecond offset fromtimeInSeconds.formatSettings -> (structure)
<p>The optional format settings for the output.</p>
framesPerSecond -> (integer)
<p>The target frame rate for the output.</p>widthInPixels -> (integer)
<p>The target width of the output, in pixels.</p>heightInPixels -> (integer)
<p>The target height of the output, in pixels.</p>dataset -> (structure)
<p>A dataset containing multiple items to process.</p>
datasetId -> (string)
<p>The unique identifier for the dataset.</p>trimSettings -> (structure)
<p>The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.</p>
startTime -> (structure)
<p>The start time for the trim range.</p>
timeInSeconds -> (long)
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided byoffsetInNanos.offsetInNanos -> (integer)
The nanosecond offset fromtimeInSeconds.endTime -> (structure)
<p>The end time for the trim range. Must be greater than startTime.</p>
timeInSeconds -> (long)
The timestamp date, in seconds, in the Unix epoch format. Fractional nanosecond data is provided byoffsetInNanos.offsetInNanos -> (integer)
The nanosecond offset fromtimeInSeconds.exportDataTypes -> (list)
<p>The optional subset of data types to export. If omitted, all data types are exported.</p>
(string)
<p>Data types that can be exported from a dataset.</p>