[ aws . finspace-data ]
get-changeset¶
Description¶
Get information about a Changeset.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
get-changeset
--dataset-id <value>
--changeset-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--dataset-id (string)
The unique identifier for the FinSpace Dataset where the Changeset is created.
--changeset-id (string)
The unique identifier of the Changeset for which to get data.
--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.
See ‘aws help’ for descriptions of global parameters.
Output¶
changesetId -> (string)
The unique identifier for a Changeset.
changesetArn -> (string)
The ARN identifier of the Changeset.
datasetId -> (string)
The unique identifier for the FinSpace Dataset where the Changeset is created.
changeType -> (string)
Type that indicates how a Changeset is applied to a Dataset.
REPLACE– Changeset is considered as a replacement to all prior loaded Changesets.
APPEND– Changeset is considered as an addition to the end of all prior loaded Changesets.
MODIFY– Changeset is considered as a replacement to a specific prior ingested Changeset.
sourceParams -> (map)
Options that define the location of the data being ingested.
key -> (string)
value -> (string)
formatParams -> (map)
Structure of the source file(s).
key -> (string)
value -> (string)
createTime -> (long)
The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
status -> (string)
The status of Changeset creation operation.
errorInfo -> (structure)
The structure with error messages.
errorMessage -> (string)
The text of the error message.
errorCategory -> (string)
The category of the error.
VALIDATION– The inputs to this request are invalid.
SERVICE_QUOTA_EXCEEDED– Service quotas have been exceeded. Please contact AWS support to increase quotas.
ACCESS_DENIED– Missing required permission to perform this request.
RESOURCE_NOT_FOUND– One or more inputs to this request were not found.
THROTTLING– The system temporarily lacks sufficient resources to process the request.
INTERNAL_SERVICE_EXCEPTION– An internal service error has occurred.
CANCELLED– Cancelled.
USER_RECOVERABLE– A user recoverable error has occurred.
activeUntilTimestamp -> (long)
Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
activeFromTimestamp -> (long)
Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
updatesChangesetId -> (string)
The unique identifier of the Changeset that is being updated.
updatedByChangesetId -> (string)
The unique identifier of the updated Changeset.