batch-disassociate-data-segments-from-dataset¶

Description¶

Disassociates a batch of data segments from a curated dataset. Disassociating a data segment doesn’t delete the underlying data in the source session dataset.

Synopsis¶

  batch-disassociate-data-segments-from-dataset
--dataset-id <value>
--workspace-name <value>
--disassociate-data-segment-entries <value>
[--client-token <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¶

--dataset-id (string) [required]

The ID of the curated dataset to disassociate data segments from.

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}$

--workspace-name (string) [required]

The name of the workspace that contains the dataset.

Constraints:

min: 1

max: 64

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

--disassociate-data-segment-entries (list) [required]

The list of data segment entries to disassociate from the dataset.

(structure)

Contains information about a data segment entry to disassociate from a dataset.

sourceDatasetId -> (string) [required]

The ID of the source dataset that contains the data segment.

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) [required]

The ID of the time series.

Constraints:

min: 36

max: 73

startTimestamp -> (structure) [required]

The nanosecond-precision start time of the data segment to disassociate.

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

endTimestamp -> (structure) [required]

The nanosecond-precision end time of the data segment to disassociate.

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

Shorthand Syntax:

sourceDatasetId=string,timeSeriesId=string,startTimestamp={timeInSeconds=long,offsetInNanos=integer},endTimestamp={timeInSeconds=long,offsetInNanos=integer} ...

JSON Syntax:

[
  {
    "sourceDatasetId": "string",
    "timeSeriesId": "string",
    "startTimestamp": {
      "timeInSeconds": long,
      "offsetInNanos": integer
    },
    "endTimestamp": {
      "timeInSeconds": long,
      "offsetInNanos": integer
    }
  }
  ...
]

--client-token (string)

A unique, case-sensitive identifier that you provide to ensure that the request is idempotent. If you retry a request that completed successfully using the same client token, the retry succeeds without performing any further actions.

Constraints:

min: 36

max: 64

pattern: \S{36,64}

--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¶

datasetId -> (string)

The ID of the dataset.

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}$

datasetVersion -> (string)

The version of the dataset after disassociation.

Constraints:

min: 1

max: 10

pattern: ^(0|([1-9]{1}\d*))$

failedDisassociations -> (list)

A list of data segment disassociations that failed.

(structure)

Contains error information for a data segment disassociation that failed.

sourceDatasetId -> (string) [required]

The ID of the source dataset.

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) [required]

The ID of the time series.

Constraints:

min: 36

max: 73

startTimestamp -> (structure) [required]

The nanosecond-precision start time of the data segment.

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

endTimestamp -> (structure) [required]

The nanosecond-precision end time of the data segment.

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

errorCode -> (string) [required]

The error code for the failed disassociation.

Possible values:

INTERNAL_FAILURE

VALIDATION_ERROR

RESOURCE_NOT_FOUND

LIMIT_EXCEEDED

CONFLICTING_OPERATION

errorMessage -> (string) [required]

The error message for the failed disassociation.

Constraints:

min: 1

max: 2048

Table of Contents

Feedback

User Guide