create-dataset-export-job¶

Description¶

Starts an asynchronous job that exports dataset and time-series data from a workspace to Amazon S3. The operation returns a jobId immediately; poll DescribeDatasetExportJob to track progress and ListDatasetExportJobs to enumerate a workspace’s jobs.

Synopsis¶

  create-dataset-export-job
--workspace-name <value>
[--client-token <value>]
--destination-s3-uri <value>
--input <value>
--error-report-location <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 workspace in which to create the dataset export job.

Constraints:

min: 1

max: 64

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

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. The AWS SDKs and CLI populate this automatically.

Constraints:

min: 36

max: 64

pattern: \S{36,64}

--destination-s3-uri (string) [required]

The S3 URI where output clips will be written.

Constraints:

min: 1

max: 1024

pattern: s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+

--input (tagged union structure) [required]

The processing input source.

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

timeseries -> (list)

List of individual timeseries items to process.

Constraints:

min: 1

max: 100

(structure)

A single timeseries item to process. Exactly one of timeSeriesId or propertyAlias must be provided.

timeSeriesId -> (string)

The unique identifier for the timeseries. Mutually exclusive with propertyAlias.

Constraints:

min: 36

max: 73

propertyAlias -> (string)

The customer-friendly alias for the timeseries. Mutually exclusive with timeSeriesId.

Constraints:

min: 1

max: 2048

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

trimSettings -> (structure)

The trim settings for the time range to export. Required for VIDEO and TELEMETRY data types; optional for ANNOTATION data types.

startTime -> (structure) [required]

The start time for the trim range.

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]

The end time for the trim range. Must be greater than startTime.

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

formatSettings -> (structure)

The optional format settings for the output.

framesPerSecond -> (integer)

The target frame rate for the output.

Constraints:

min: 1

widthInPixels -> (integer)

The target width of the output, in pixels.

Constraints:

min: 1

heightInPixels -> (integer)

The target height of the output, in pixels.

Constraints:

min: 1

dataset -> (structure)

A dataset containing multiple items to process.

datasetId -> (string) [required]

The unique identifier for the dataset.

Constraints:

min: 36

max: 36

pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$

trimSettings -> (structure)

The trim settings applied to all items in the dataset. When omitted, the full dataset time range is used.

startTime -> (structure) [required]

The start time for the trim range.

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]

The end time for the trim range. Must be greater than startTime.

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

exportDataTypes -> (list)

The optional subset of data types to export. If omitted, all data types are exported.

Constraints:

min: 1

max: 3

(string)

Data types that can be exported from a dataset.

Possible values:

VIDEO

TELEMETRY

ANNOTATION

JSON Syntax:

{
  "timeseries": [
    {
      "timeSeriesId": "string",
      "propertyAlias": "string",
      "trimSettings": {
        "startTime": {
          "timeInSeconds": long,
          "offsetInNanos": integer
        },
        "endTime": {
          "timeInSeconds": long,
          "offsetInNanos": integer
        }
      },
      "formatSettings": {
        "framesPerSecond": integer,
        "widthInPixels": integer,
        "heightInPixels": integer
      }
    }
    ...
  ],
  "dataset": {
    "datasetId": "string",
    "trimSettings": {
      "startTime": {
        "timeInSeconds": long,
        "offsetInNanos": integer
      },
      "endTime": {
        "timeInSeconds": long,
        "offsetInNanos": integer
      }
    },
    "exportDataTypes": ["VIDEO"|"TELEMETRY"|"ANNOTATION", ...]
  }
}

--error-report-location (structure) [required]

The location where the error report will be written on failure.

s3Uri -> (string) [required]

The S3 URI prefix for the error report.

Constraints:

min: 1

max: 1024

pattern: s3://[a-z0-9][a-z0-9.-]{1,61}[a-z0-9]/.+

Shorthand Syntax:

s3Uri=string

JSON Syntax:

{
  "s3Uri": "string"
}

--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 for the dataset export job.

Constraints:

min: 36

max: 36

pattern: [0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}

workspaceName -> (string)

The name of the workspace in which the dataset export job was created.

Constraints:

min: 1

max: 64

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

Table of Contents

Feedback

User Guide