"documentation":"<p>A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.</p>"
},
"ListChangesets":{
"name":"ListChangesets",
"http":{
"method":"GET",
"requestUri":"/datasets/{datasetId}/changesetsv2"
},
"input":{"shape":"ListChangesetsRequest"},
"output":{"shape":"ListChangesetsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ValidationException"},
{"shape":"ThrottlingException"},
{"shape":"AccessDeniedException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Lists the FinSpace Changesets for a Dataset.</p>"
},
"ListDataViews":{
"name":"ListDataViews",
"http":{
"method":"GET",
"requestUri":"/datasets/{datasetId}/dataviewsv2"
},
"input":{"shape":"ListDataViewsRequest"},
"output":{"shape":"ListDataViewsResponse"},
"errors":[
{"shape":"ResourceNotFoundException"},
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ConflictException"}
],
"documentation":"<p>Lists all available Dataviews for a Dataset.</p>"
},
"ListDatasets":{
"name":"ListDatasets",
"http":{
"method":"GET",
"requestUri":"/datasetsv2"
},
"input":{"shape":"ListDatasetsRequest"},
"output":{"shape":"ListDatasetsResponse"},
"errors":[
{"shape":"InternalServerException"},
{"shape":"ThrottlingException"},
{"shape":"ValidationException"},
{"shape":"ConflictException"},
{"shape":"ResourceNotFoundException"}
],
"documentation":"<p>Lists all of the active Datasets that a user has access to.</p>"
"documentation":"<p>The text of the error message.</p>"
},
"errorCategory":{
"shape":"ErrorCategory",
"documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> -The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> - Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> - Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> - A user recoverable error has occurred.</p> </li> </ul>"
}
},
"documentation":"<p>The structure with error messages.</p>"
},
"ChangesetId":{
"type":"string",
"documentation":"ID used to identify a Changeset",
"max":26,
"min":1
},
"ChangesetList":{
"type":"list",
"member":{"shape":"ChangesetSummary"},
"documentation":"List of Changeset Summaries"
},
"ChangesetSummary":{
"type":"structure",
"members":{
"changesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier for a Changeset.</p>"
"documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
},
"sourceParams":{
"shape":"SourceParams",
"documentation":"<p>Options that define the location of the data being ingested.</p>"
},
"formatParams":{
"shape":"FormatParams",
"documentation":"<p>Options that define the structure of the source file(s).</p>"
},
"createTime":{
"shape":"TimestampEpoch",
"documentation":"<p>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.</p>"
},
"status":{
"shape":"IngestionStatus",
"documentation":"<p>Status of the Changeset ingestion.</p> <ul> <li> <p> <code>PENDING</code> - Changeset is pending creation.</p> </li> <li> <p> <code>FAILED</code> - Changeset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> - Changeset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> - Changeset creation is running.</p> </li> <li> <p> <code>STOP_REQUESTED</code> - User requested Changeset creation to stop.</p> </li> </ul>"
},
"errorInfo":{
"shape":"ChangesetErrorInfo",
"documentation":"<p>The structure with error messages.</p>"
},
"activeUntilTimestamp":{
"shape":"TimestampEpoch",
"documentation":"<p>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.</p>",
"documentation":"<p>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.</p>",
"box":true
},
"updatesChangesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier of the Changeset that is updated.</p>"
},
"updatedByChangesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier of the updated Changeset.</p>"
}
},
"documentation":"<p>A Changeset is unit of data in a Dataset.</p>"
},
"ClientToken":{
"type":"string",
"documentation":"Idempotence Token for API operations",
"max":128,
"min":1,
"pattern":".*\\S.*"
},
"ColumnDataType":{
"type":"string",
"documentation":"Data type of a column.",
"enum":[
"STRING",
"CHAR",
"INTEGER",
"TINYINT",
"SMALLINT",
"BIGINT",
"FLOAT",
"DOUBLE",
"DATE",
"DATETIME",
"BOOLEAN",
"BINARY"
]
},
"ColumnDefinition":{
"type":"structure",
"members":{
"dataType":{
"shape":"ColumnDataType",
"documentation":"<p>Data type of a column.</p> <ul> <li> <p> <code>STRING</code> - A String data type.</p> <p> <code>CHAR</code> - A char data type.</p> <p> <code>INTEGER</code> - An integer data type.</p> <p> <code>TINYINT</code> - A tinyint data type.</p> <p> <code>SMALLINT</code> - A smallint data type.</p> <p> <code>BIGINT</code> - A bigint data type.</p> <p> <code>FLOAT</code> - A float data type.</p> <p> <code>DOUBLE</code> - A double data type.</p> <p> <code>DATE</code> - A date data type.</p> <p> <code>DATETIME</code> - A datetime data type.</p> <p> <code>BOOLEAN</code> - A boolean data type.</p> <p> <code>BINARY</code> - A binary data type.</p> </li> </ul>"
},
"columnName":{
"shape":"ColumnName",
"documentation":"<p>Name for a column.</p>"
},
"columnDescription":{
"shape":"ColumnDescription",
"documentation":"<p>Description for a column.</p>"
}
},
"documentation":"<p>The definition of a column in a tabular Dataset.</p>"
},
"ColumnDescription":{
"type":"string",
"documentation":"Column Description",
"max":512,
"pattern":"[\\s\\S]*\\S[\\s\\S]*"
},
"ColumnList":{
"type":"list",
"member":{"shape":"ColumnDefinition"},
"documentation":"List of Column Definitions"
},
"ColumnName":{
"type":"string",
"documentation":"Column Name",
"max":126,
"pattern":".*\\S.*"
},
"ColumnNameList":{
"type":"list",
"member":{"shape":"ColumnName"},
"documentation":"List of Column Names"
},
"ConflictException":{
"type":"structure",
"members":{
"message":{"shape":"errorMessage"}
},
"documentation":"<p>The request conflicts with an existing resource.</p>",
"error":{"httpStatusCode":409},
"exception":true
},
"CreateChangesetRequest":{
"type":"structure",
"required":[
"datasetId",
"changeType",
"sourceParams",
"formatParams"
],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
"idempotencyToken":true
},
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset will be created. </p>",
"location":"uri",
"locationName":"datasetId"
},
"changeType":{
"shape":"ChangeType",
"documentation":"<p>Option to indicate how a Changeset will be applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset will be considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset will be considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
"documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>"
},
"formatParams":{
"shape":"FormatParams",
"documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> - Parquet source file format.</p> </li> <li> <p> <code>CSV</code> - CSV source file format.</p> </li> <li> <p> <code>JSON</code> - JSON source file format.</p> </li> <li> <p> <code>XML</code> - XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
}
},
"documentation":"The request for a CreateChangeset operation."
},
"CreateChangesetResponse":{
"type":"structure",
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>"
},
"changesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier of the Changeset that is created.</p>"
}
},
"documentation":"The response from a CreateChangeset operation."
},
"CreateDataViewRequest":{
"type":"structure",
"required":[
"datasetId",
"destinationTypeParams"
],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
"idempotencyToken":true
},
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique Dataset identifier that is used to create a Dataview.</p>",
"location":"uri",
"locationName":"datasetId"
},
"autoUpdate":{
"shape":"Boolean",
"documentation":"<p>Flag to indicate Dataview should be updated automatically.</p>"
},
"sortColumns":{
"shape":"SortColumnList",
"documentation":"<p>Columns to be used for sorting the data.</p>"
},
"partitionColumns":{
"shape":"PartitionColumnList",
"documentation":"<p>Ordered set of column names used to partition data.</p>"
},
"asOfTimestamp":{
"shape":"TimestampEpoch",
"documentation":"<p>Beginning time to use for the Dataview. 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.</p>",
"box":true
},
"destinationTypeParams":{
"shape":"DataViewDestinationTypeParams",
"documentation":"<p>Options that define the destination type for the Dataview.</p>"
}
},
"documentation":"Request for creating a data view."
},
"CreateDataViewResponse":{
"type":"structure",
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier of the Dataset used for the Dataview.</p>"
},
"dataViewId":{
"shape":"DataViewId",
"documentation":"<p>The unique identifier for the created Dataview.</p>"
}
},
"documentation":"Response for creating a data view."
},
"CreateDatasetRequest":{
"type":"structure",
"required":[
"datasetTitle",
"kind",
"permissionGroupParams"
],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
"idempotencyToken":true
},
"datasetTitle":{
"shape":"DatasetTitle",
"documentation":"<p>Display title for a FinSpace Dataset.</p>"
},
"kind":{
"shape":"DatasetKind",
"documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
"documentation":"<p>Description of a Dataset.</p>"
},
"ownerInfo":{
"shape":"DatasetOwnerInfo",
"documentation":"<p>Contact information for a Dataset owner.</p>"
},
"permissionGroupParams":{
"shape":"PermissionGroupParams",
"documentation":"<p>Permission group parameters for Dataset permissions.</p>"
},
"alias":{
"shape":"AliasString",
"documentation":"<p>The unique resource identifier for a Dataset.</p>"
},
"schemaDefinition":{
"shape":"SchemaUnion",
"documentation":"<p>Definition for a schema on a tabular Dataset.</p>"
}
},
"documentation":"The request for a CreateDataset operation"
},
"CreateDatasetResponse":{
"type":"structure",
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the created Dataset.</p>"
}
},
"documentation":"The response from a CreateDataset operation"
"documentation":"<p>Format Options for S3 Destination type.</p> <p>Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code> </p> <p> <code> { \"header\": \"true\", \"delimiter\": \",\", \"compression\": \"gzip\" }</code> </p>"
}
},
"documentation":"<p>Structure for the Dataview destination type parameters.</p>"
},
"DataViewErrorInfo":{
"type":"structure",
"members":{
"errorMessage":{
"shape":"ErrorMessage",
"documentation":"<p>The text of the error message.</p>"
},
"errorCategory":{
"shape":"ErrorCategory",
"documentation":"<p>The category of the error.</p> <ul> <li> <p> <code>VALIDATION</code> -The inputs to this request are invalid.</p> </li> <li> <p> <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please contact AWS support to increase quotas.</p> </li> <li> <p> <code>ACCESS_DENIED</code> - Missing required permission to perform this request.</p> </li> <li> <p> <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not found.</p> </li> <li> <p> <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process the request.</p> </li> <li> <p> <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has occurred.</p> </li> <li> <p> <code>CANCELLED</code> - Cancelled.</p> </li> <li> <p> <code>USER_RECOVERABLE</code> - A user recoverable error has occurred.</p> </li> </ul>"
}
},
"documentation":"<p>The structure with error messages.</p>"
},
"DataViewId":{
"type":"string",
"documentation":"DataView ID",
"max":26,
"min":1
},
"DataViewList":{
"type":"list",
"member":{"shape":"DataViewSummary"},
"documentation":"List of Data Views"
},
"DataViewStatus":{
"type":"string",
"documentation":"Status of a DataView",
"enum":[
"RUNNING",
"STARTING",
"FAILED",
"CANCELLED",
"TIMEOUT",
"SUCCESS",
"PENDING",
"FAILED_CLEANUP_FAILED"
]
},
"DataViewSummary":{
"type":"structure",
"members":{
"dataViewId":{
"shape":"DataViewId",
"documentation":"<p>The unique identifier for the Dataview.</p>"
},
"dataViewArn":{
"shape":"DataViewArn",
"documentation":"<p>The ARN identifier of the Dataview.</p>"
"documentation":"<p>Th unique identifier for the Dataview Dataset.</p>"
},
"asOfTimestamp":{
"shape":"TimestampEpoch",
"documentation":"<p>Time range to use for the Dataview. 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.</p>",
"box":true
},
"partitionColumns":{
"shape":"PartitionColumnList",
"documentation":"<p>Ordered set of column names used to partition data.</p>"
},
"sortColumns":{
"shape":"SortColumnList",
"documentation":"<p>Columns to be used for sorting the data.</p>"
},
"status":{
"shape":"DataViewStatus",
"documentation":"<p>The status of a Dataview creation.</p> <ul> <li> <p> <code>RUNNING</code> - Dataview creation is running.</p> </li> <li> <p> <code>STARTING</code> - Dataview creation is starting.</p> </li> <li> <p> <code>FAILED</code> - Dataview creation has failed.</p> </li> <li> <p> <code>CANCELLED</code> - Dataview creation has been cancelled.</p> </li> <li> <p> <code>TIMEOUT</code> - Dataview creation has timed out.</p> </li> <li> <p> <code>SUCCESS</code> - Dataview creation has succeeded.</p> </li> <li> <p> <code>PENDING</code> - Dataview creation is pending.</p> </li> <li> <p> <code>FAILED_CLEANUP_FAILED</code> - Dataview creation failed and resource cleanup failed.</p> </li> </ul>"
},
"errorInfo":{
"shape":"DataViewErrorInfo",
"documentation":"<p>The structure with error messages.</p>"
},
"destinationTypeProperties":{
"shape":"DataViewDestinationTypeParams",
"documentation":"<p>Information about the Dataview destination.</p>"
},
"autoUpdate":{
"shape":"Boolean",
"documentation":"<p>The flag to indicate Dataview should be updated automatically.</p>"
},
"createTime":{
"shape":"TimestampEpoch",
"documentation":"<p>The timestamp at which the Dataview 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.</p>"
},
"lastModifiedTime":{
"shape":"TimestampEpoch",
"documentation":"<p>The last time that a Dataview was modified. 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.</p>"
}
},
"documentation":"<p>Structure for the summary of a Dataview.</p>"
},
"Dataset":{
"type":"structure",
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>An identifier for a Dataset.</p>"
},
"datasetArn":{
"shape":"DatasetArn",
"documentation":"<p>The ARN identifier of the Dataset.</p>"
},
"datasetTitle":{
"shape":"DatasetTitle",
"documentation":"<p>Display title for a Dataset.</p>"
},
"kind":{
"shape":"DatasetKind",
"documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
"documentation":"<p>Description for a Dataset.</p>"
},
"ownerInfo":{
"shape":"DatasetOwnerInfo",
"documentation":"<p>Contact information for a Dataset owner.</p>"
},
"createTime":{
"shape":"TimestampEpoch",
"documentation":"<p>The timestamp at which the Dataset 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.</p>"
},
"lastModifiedTime":{
"shape":"TimestampEpoch",
"documentation":"<p>The last time that the Dataset was modified. 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.</p>"
},
"schemaDefinition":{
"shape":"SchemaUnion",
"documentation":"<p>Definition for a schema on a tabular Dataset.</p>"
},
"alias":{
"shape":"AliasString",
"documentation":"<p>The unique resource identifier for a Dataset.</p>"
}
},
"documentation":"<p>The structure for a Dataset.</p>"
},
"DatasetArn":{
"type":"string",
"documentation":"Arn of a Dataset"
},
"DatasetDescription":{
"type":"string",
"documentation":"Description of a dataset",
"max":1000,
"min":1,
"pattern":"[\\s\\S]*\\S[\\s\\S]*"
},
"DatasetId":{
"type":"string",
"documentation":"ID for a given Dataset",
"max":26,
"min":1
},
"DatasetKind":{
"type":"string",
"documentation":"Dataset Kind",
"enum":[
"TABULAR",
"NON_TABULAR"
]
},
"DatasetList":{
"type":"list",
"member":{"shape":"Dataset"},
"documentation":"List of Dataset structures"
},
"DatasetOwnerInfo":{
"type":"structure",
"members":{
"name":{
"shape":"OwnerName",
"documentation":"<p>Name of the Dataset owner.</p>"
},
"phoneNumber":{
"shape":"PhoneNumber",
"documentation":"<p>Phone number for the Dataset owner.</p>"
},
"email":{
"shape":"Email",
"documentation":"<p>Email address for the Dataset owner.</p>"
}
},
"documentation":"<p>A structure for Dataset owner info.</p>"
},
"DatasetStatus":{
"type":"string",
"documentation":"Status of the dataset process returned from scheduler service.",
"enum":[
"PENDING",
"FAILED",
"SUCCESS",
"RUNNING"
]
},
"DatasetTitle":{
"type":"string",
"documentation":"Title for a given Dataset",
"max":255,
"min":1,
"pattern":".*\\S.*"
},
"DeleteDatasetRequest":{
"type":"structure",
"required":["datasetId"],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
"idempotencyToken":true,
"location":"querystring",
"locationName":"clientToken"
},
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier of the Dataset to be deleted.</p>",
"location":"uri",
"locationName":"datasetId"
}
},
"documentation":"The request for a DeleteDataset operation."
},
"DeleteDatasetResponse":{
"type":"structure",
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the deleted Dataset.</p>"
}
},
"documentation":"The response from an DeleteDataset operation"
"documentation":"Format Parameters of a Changeset"
},
"GetChangesetRequest":{
"type":"structure",
"required":[
"datasetId",
"changesetId"
],
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>",
"location":"uri",
"locationName":"datasetId"
},
"changesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier of the Changeset for which to get data.</p>",
"location":"uri",
"locationName":"changesetId"
}
},
"documentation":"Request to describe a changeset."
},
"GetChangesetResponse":{
"type":"structure",
"members":{
"changesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier for a Changeset.</p>"
},
"changesetArn":{
"shape":"ChangesetArn",
"documentation":"<p>The ARN identifier of the Changeset.</p>"
},
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the FinSpace Dataset where the Changeset is created.</p>"
},
"changeType":{
"shape":"ChangeType",
"documentation":"<p>Type that indicates how a Changeset is applied to a Dataset.</p> <ul> <li> <p> <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded Changesets.</p> </li> <li> <p> <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded Changesets.</p> </li> <li> <p> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset.</p> </li> </ul>"
},
"sourceParams":{
"shape":"SourceParams",
"documentation":"<p>Options that define the location of the data being ingested.</p>"
"documentation":"<p>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.</p>"
"documentation":"<p>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.</p>",
"box":true
},
"activeFromTimestamp":{
"shape":"TimestampEpoch",
"documentation":"<p>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.</p>",
"documentation":"<p>Time range to use for the Dataview. 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.</p>",
"documentation":"<p>The last time that a Dataview was modified. 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.</p>"
"documentation":"<p>The timestamp at which the Dataview 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.</p>"
},
"sortColumns":{
"shape":"SortColumnList",
"documentation":"<p>Columns to be used for sorting the data.</p>"
},
"dataViewId":{
"shape":"DataViewId",
"documentation":"<p>The unique identifier for the Dataview.</p>"
},
"dataViewArn":{
"shape":"DataViewArn",
"documentation":"<p>The ARN identifier of the Dataview.</p>"
"documentation":"<p>The format in which Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
"documentation":"<p>A description of the Dataset.</p>"
},
"createTime":{
"shape":"TimestampEpoch",
"documentation":"<p>The timestamp at which the Dataset 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.</p>"
},
"lastModifiedTime":{
"shape":"TimestampEpoch",
"documentation":"<p>The last time that the Dataset was modified. 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.</p>"
},
"schemaDefinition":{
"shape":"SchemaUnion",
"documentation":"<p>Definition for a schema on a tabular Dataset.</p>"
},
"alias":{
"shape":"AliasString",
"documentation":"<p>The unique resource identifier for a Dataset.</p>"
},
"status":{
"shape":"DatasetStatus",
"documentation":"<p>Status of the Dataset creation.</p> <ul> <li> <p> <code>PENDING</code> - Dataset is pending creation.</p> </li> <li> <p> <code>FAILED</code> - Dataset creation has failed.</p> </li> <li> <p> <code>SUCCESS</code> - Dataset creation has succeeded.</p> </li> <li> <p> <code>RUNNING</code> - Dataset creation is running.</p> </li> </ul>"
"documentation":"<p>Specify the type of the working location.</p> <ul> <li> <p> <code>SAGEMAKER</code> - Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.</p> </li> <li> <p> <code>INGESTION</code> - Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.</p> </li> </ul>"
"documentation":"<p>The unique identifier for the FinSpace Dataset to which the Changeset belongs.</p>",
"location":"uri",
"locationName":"datasetId"
},
"maxResults":{
"shape":"ResultLimit",
"documentation":"<p>The maximum number of results per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token indicating where a results page should begin.</p>",
"location":"querystring",
"locationName":"nextToken"
}
},
"documentation":"Request to ListChangesetsRequest. It exposes minimal query filters."
},
"ListChangesetsResponse":{
"type":"structure",
"members":{
"changesets":{
"shape":"ChangesetList",
"documentation":"<p>List of Changesets found.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token indicating where a results page should begin.</p>"
}
},
"documentation":"Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria."
},
"ListDataViewsRequest":{
"type":"structure",
"required":["datasetId"],
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier of the Dataset for which to retrieve Dataviews.</p>",
"location":"uri",
"locationName":"datasetId"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token indicating where a results page should begin.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"ResultLimit",
"documentation":"<p>The maximum number of results per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
},
"documentation":"Request for a list data views."
},
"ListDataViewsResponse":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token indicating where a results page should begin.</p>"
},
"dataViews":{
"shape":"DataViewList",
"documentation":"<p>A list of Dataviews.</p>"
}
}
},
"ListDatasetsRequest":{
"type":"structure",
"members":{
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token indicating where a results page should begin.</p>",
"location":"querystring",
"locationName":"nextToken"
},
"maxResults":{
"shape":"ResultLimit",
"documentation":"<p>The maximum number of results per page.</p>",
"box":true,
"location":"querystring",
"locationName":"maxResults"
}
},
"documentation":"Request for the ListDatasets operation."
},
"ListDatasetsResponse":{
"type":"structure",
"members":{
"datasets":{
"shape":"DatasetList",
"documentation":"<p>List of Datasets.</p>"
},
"nextToken":{
"shape":"PaginationToken",
"documentation":"<p>A token indicating where a results page should begin.</p>"
}
},
"documentation":"Response for the ListDatasets operation"
},
"OwnerName":{
"type":"string",
"documentation":"1 - 250 character String",
"max":250,
"min":1,
"pattern":".*\\S.*"
},
"PaginationToken":{
"type":"string",
"documentation":"Pagination token for list operations"
},
"PartitionColumnList":{
"type":"list",
"member":{"shape":"StringValueLength1to255"},
"documentation":"DataView Partition Column List"
},
"PermissionGroupId":{
"type":"string",
"documentation":"Id of the associated PermissionGroup",
"max":26,
"min":1
},
"PermissionGroupParams":{
"type":"structure",
"members":{
"permissionGroupId":{
"shape":"PermissionGroupId",
"documentation":"<p>The unique identifier of the PermissionGroup.</p>"
},
"datasetPermissions":{
"shape":"ResourcePermissionsList",
"documentation":"<p>List of resource permissions.</p>"
}
},
"documentation":"<p>Permission group parameters for Dataset permissions.</p> <p>Here is an example of how you could specify the <code>PermissionGroupParams</code>:</p> <p> <code> { \"permissionGroupId\": \"0r6fCRtSTUk4XPfXQe3M0g\", \"datasetPermissions\": [ {\"permission\": \"ViewDatasetDetails\"}, {\"permission\": \"AddDatasetData\"}, {\"permission\": \"EditDatasetMetadata\"}, {\"permission\": \"DeleteDataset\"} ] } </code> </p>"
"documentation":"<p>Permission for a resource.</p>"
}
},
"documentation":"<p>Resource permission for a dataset. When you create a dataset, all the other members of the same user group inherit access to the dataset. You can only create a dataset if your user group has application permission for Create Datasets.</p> <p>The following is a list of valid dataset permissions that you can apply: </p> <ul> <li> <p> <code>ViewDatasetDetails</code> </p> </li> <li> <p> <code>ReadDatasetDetails</code> </p> </li> <li> <p> <code>AddDatasetData</code> </p> </li> <li> <p> <code>CreateSnapshot</code> </p> </li> <li> <p> <code>EditDatasetMetadata</code> </p> </li> <li> <p> <code>DeleteDataset</code> </p> </li> </ul> <p>For more information on the ataset permissions, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/managing-user-permissions.html#supported-dataset-permissions\">Supported Dataset Permissions</a> in the FinSpace User Guide.</p>"
},
"ResourcePermissionsList":{
"type":"list",
"member":{"shape":"ResourcePermission"},
"documentation":"List of Resource Permissions"
},
"ResultLimit":{
"type":"integer",
"documentation":"Maximum number of results to be returned as part of a list operation",
"max":100,
"min":1
},
"S3DestinationFormatOptions":{
"type":"map",
"key":{"shape":"StringMapKey"},
"value":{"shape":"StringMapValue"}
},
"SchemaDefinition":{
"type":"structure",
"members":{
"columns":{
"shape":"ColumnList",
"documentation":"<p>List of column definitions.</p>"
},
"primaryKeyColumns":{
"shape":"ColumnNameList",
"documentation":"<p>List of column names used for primary key.</p>"
}
},
"documentation":"<p>Definition for a schema on a tabular Dataset.</p>"
},
"SchemaUnion":{
"type":"structure",
"members":{
"tabularSchemaConfig":{
"shape":"SchemaDefinition",
"documentation":"<p>The configuration for a schema on a tabular Dataset.</p>"
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
"idempotencyToken":true
},
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>",
"location":"uri",
"locationName":"datasetId"
},
"changesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier for the Changeset to update.</p>",
"location":"uri",
"locationName":"changesetId"
},
"sourceParams":{
"shape":"SourceParams",
"documentation":"<p>Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>).</p> <p>Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes.</p> <p>Here is an example of how you could specify the <code>sourceParams</code>:</p> <p> <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> </p> <p>The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see <a href=\"https://docs.aws.amazon.com/finspace/latest/data-api/fs-using-the-finspace-api.html#access-s3-buckets\">Loading data from an Amazon S3 Bucket using the FinSpace API</a>section.</p>"
},
"formatParams":{
"shape":"FormatParams",
"documentation":"<p>Options that define the structure of the source file(s) including the format type (<code>formatType</code>), header row (<code>withHeader</code>), data separation character (<code>separator</code>) and the type of compression (<code>compression</code>). </p> <p> <code>formatType</code> is a required attribute and can have the following values: </p> <ul> <li> <p> <code>PARQUET</code> - Parquet source file format.</p> </li> <li> <p> <code>CSV</code> - CSV source file format.</p> </li> <li> <p> <code>JSON</code> - JSON source file format.</p> </li> <li> <p> <code>XML</code> - XML source file format.</p> </li> </ul> <p>Here is an example of how you could specify the <code>formatParams</code>:</p> <p> <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> </p> <p>Note that if you only provide <code>formatType</code> as <code>CSV</code>, the rest of the attributes will automatically default to CSV values as following:</p> <p> <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> </p> <p> For more information about supported file formats, see <a href=\"https://docs.aws.amazon.com/finspace/latest/userguide/supported-data-types.html\">Supported Data Types and File Formats</a> in the FinSpace User Guide.</p>"
}
},
"documentation":"Request to update an existing changeset."
},
"UpdateChangesetResponse":{
"type":"structure",
"members":{
"changesetId":{
"shape":"ChangesetId",
"documentation":"<p>The unique identifier for the Changeset to update.</p>"
},
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the FinSpace Dataset in which the Changeset is created.</p>"
}
},
"documentation":"The response from a update changeset operation."
},
"UpdateDatasetRequest":{
"type":"structure",
"required":[
"datasetId",
"datasetTitle",
"kind"
],
"members":{
"clientToken":{
"shape":"ClientToken",
"documentation":"<p>A token that ensures idempotency. This token expires in 10 minutes.</p>",
"idempotencyToken":true
},
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for the Dataset to update.</p>",
"location":"uri",
"locationName":"datasetId"
},
"datasetTitle":{
"shape":"DatasetTitle",
"documentation":"<p>A display title for the Dataset.</p>"
},
"kind":{
"shape":"DatasetKind",
"documentation":"<p>The format in which the Dataset data is structured.</p> <ul> <li> <p> <code>TABULAR</code> - Data is structured in a tabular format.</p> </li> <li> <p> <code>NON_TABULAR</code> - Data is structured in a non-tabular format.</p> </li> </ul>"
},
"datasetDescription":{
"shape":"DatasetDescription",
"documentation":"<p>A description for the Dataset.</p>"
},
"alias":{
"shape":"AliasString",
"documentation":"<p>The unique resource identifier for a Dataset.</p>"
},
"schemaDefinition":{
"shape":"SchemaUnion",
"documentation":"<p>Definition for a schema on a tabular Dataset.</p>"
}
},
"documentation":"The request for an UpdateDataset operation"
},
"UpdateDatasetResponse":{
"type":"structure",
"members":{
"datasetId":{
"shape":"DatasetId",
"documentation":"<p>The unique identifier for updated Dataset.</p>"
}
},
"documentation":"The response from an UpdateDataset operation"