TripleDNN

Current Directory: /usr/lib/fence-agents/bundled/botocore/data/finspace-data/2020-07-13

File Name	Size	Actions
paginators-1.json	517 bytes	Edit \| Delete \| Rename \| Download
service-2.json	67916 bytes	Edit \| Delete \| Rename \| Download

{
 "version":"2.0",
 "metadata":{
 "apiVersion":"2020-07-13",
 "endpointPrefix":"finspace-api",
 "jsonVersion":"1.1",
 "protocol":"rest-json",
 "serviceAbbreviation":"FinSpace Data",
 "serviceFullName":"FinSpace Public API",
 "serviceId":"finspace data",
 "signatureVersion":"v4",
 "signingName":"finspace-api",
 "uid":"finspace-2020-07-13"
 },
 "operations":{
 "CreateChangeset":{
 "name":"CreateChangeset",
 "http":{
 "method":"POST",
 "requestUri":"/datasets/{datasetId}/changesetsv2"
 },
 "input":{"shape":"CreateChangesetRequest"},
 "output":{"shape":"CreateChangesetResponse"},
 "errors":[
 {"shape":"ResourceNotFoundException"},
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"},
 {"shape":"LimitExceededException"},
 {"shape":"ConflictException"}
 ],
 "documentation":"Creates a new Changeset in a FinSpace Dataset."
 },
 "CreateDataView":{
 "name":"CreateDataView",
 "http":{
 "method":"POST",
 "requestUri":"/datasets/{datasetId}/dataviewsv2"
 },
 "input":{"shape":"CreateDataViewRequest"},
 "output":{"shape":"CreateDataViewResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ThrottlingException"},
 {"shape":"ValidationException"},
 {"shape":"LimitExceededException"},
 {"shape":"ConflictException"},
 {"shape":"ResourceNotFoundException"}
 ],
 "documentation":"Creates a Dataview for a Dataset."
 },
 "CreateDataset":{
 "name":"CreateDataset",
 "http":{
 "method":"POST",
 "requestUri":"/datasetsv2"
 },
 "input":{"shape":"CreateDatasetRequest"},
 "output":{"shape":"CreateDatasetResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"},
 {"shape":"LimitExceededException"},
 {"shape":"ConflictException"},
 {"shape":"ResourceNotFoundException"}
 ],
 "documentation":"Creates a new FinSpace Dataset."
 },
 "DeleteDataset":{
 "name":"DeleteDataset",
 "http":{
 "method":"DELETE",
 "requestUri":"/datasetsv2/{datasetId}"
 },
 "input":{"shape":"DeleteDatasetRequest"},
 "output":{"shape":"DeleteDatasetResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ResourceNotFoundException"},
 {"shape":"LimitExceededException"},
 {"shape":"ConflictException"}
 ],
 "documentation":"Deletes a FinSpace Dataset."
 },
 "GetChangeset":{
 "name":"GetChangeset",
 "http":{
 "method":"GET",
 "requestUri":"/datasets/{datasetId}/changesetsv2/{changesetId}"
 },
 "input":{"shape":"GetChangesetRequest"},
 "output":{"shape":"GetChangesetResponse"},
 "errors":[
 {"shape":"ResourceNotFoundException"},
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ConflictException"}
 ],
 "documentation":"Get information about a Changeset."
 },
 "GetDataView":{
 "name":"GetDataView",
 "http":{
 "method":"GET",
 "requestUri":"/datasets/{datasetId}/dataviewsv2/{dataviewId}"
 },
 "input":{"shape":"GetDataViewRequest"},
 "output":{"shape":"GetDataViewResponse"},
 "errors":[
 {"shape":"ResourceNotFoundException"},
 {"shape":"InternalServerException"},
 {"shape":"ThrottlingException"},
 {"shape":"ValidationException"},
 {"shape":"ConflictException"}
 ],
 "documentation":"Gets information about a Dataview."
 },
 "GetDataset":{
 "name":"GetDataset",
 "http":{
 "method":"GET",
 "requestUri":"/datasetsv2/{datasetId}"
 },
 "input":{"shape":"GetDatasetRequest"},
 "output":{"shape":"GetDatasetResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ResourceNotFoundException"},
 {"shape":"ConflictException"}
 ],
 "documentation":"Returns information about a Dataset."
 },
 "GetProgrammaticAccessCredentials":{
 "name":"GetProgrammaticAccessCredentials",
 "http":{
 "method":"GET",
 "requestUri":"/credentials/programmatic"
 },
 "input":{"shape":"GetProgrammaticAccessCredentialsRequest"},
 "output":{"shape":"GetProgrammaticAccessCredentialsResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"}
 ],
 "documentation":"Request programmatic credentials to use with FinSpace SDK."
 },
 "GetWorkingLocation":{
 "name":"GetWorkingLocation",
 "http":{
 "method":"POST",
 "requestUri":"/workingLocationV1"
 },
 "input":{"shape":"GetWorkingLocationRequest"},
 "output":{"shape":"GetWorkingLocationResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ThrottlingException"},
 {"shape":"ValidationException"}
 ],
 "documentation":"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."
 },
 "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":"Lists the FinSpace Changesets for a Dataset."
 },
 "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":"Lists all available Dataviews for a Dataset."
 },
 "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":"Lists all of the active Datasets that a user has access to."
 },
 "UpdateChangeset":{
 "name":"UpdateChangeset",
 "http":{
 "method":"PUT",
 "requestUri":"/datasets/{datasetId}/changesetsv2/{changesetId}"
 },
 "input":{"shape":"UpdateChangesetRequest"},
 "output":{"shape":"UpdateChangesetResponse"},
 "errors":[
 {"shape":"ResourceNotFoundException"},
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ConflictException"}
 ],
 "documentation":"Updates a FinSpace Changeset."
 },
 "UpdateDataset":{
 "name":"UpdateDataset",
 "http":{
 "method":"PUT",
 "requestUri":"/datasetsv2/{datasetId}"
 },
 "input":{"shape":"UpdateDatasetRequest"},
 "output":{"shape":"UpdateDatasetResponse"},
 "errors":[
 {"shape":"InternalServerException"},
 {"shape":"ValidationException"},
 {"shape":"ThrottlingException"},
 {"shape":"AccessDeniedException"},
 {"shape":"ConflictException"},
 {"shape":"ResourceNotFoundException"}
 ],
 "documentation":"Updates a FinSpace Dataset."
 }
 },
 "shapes":{
 "AccessDeniedException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"You do not have sufficient access to perform this action.",
 "error":{"httpStatusCode":403},
 "exception":true
 },
 "AliasString":{
 "type":"string",
 "max":255,
 "min":1,
 "pattern":"^alias\\/\\S+"
 },
 "Boolean":{
 "type":"boolean",
 "documentation":"Common Boolean data type"
 },
 "ChangeType":{
 "type":"string",
 "documentation":"Indicates how the given change will be applied to the dataset.",
 "enum":[
 "REPLACE",
 "APPEND",
 "MODIFY"
 ]
 },
 "ChangesetArn":{
 "type":"string",
 "documentation":"Arn for a given Changeset"
 },
 "ChangesetErrorInfo":{
 "type":"structure",
 "members":{
 "errorMessage":{
 "shape":"ErrorMessage",
 "documentation":"The text of the error message."
 },
 "errorCategory":{
 "shape":"ErrorCategory",
 "documentation":"The category of the error. <ul> <li> <code>VALIDATION</code> -The inputs to this request are invalid. </li> <li> <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please contact AWS support to increase quotas. </li> <li> <code>ACCESS_DENIED</code> - Missing required permission to perform this request. </li> <li> <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not found. </li> <li> <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process the request. </li> <li> <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has occurred. </li> <li> <code>CANCELLED</code> - Cancelled. </li> <li> <code>USER_RECOVERABLE</code> - A user recoverable error has occurred. </li> </ul>"
 }
 },
 "documentation":"The structure with error messages."
 },
 "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":"The unique identifier for a Changeset."
 },
 "changesetArn":{
 "shape":"ChangesetArn",
 "documentation":"The ARN identifier of the Changeset."
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset in which the Changeset is created."
 },
 "changeType":{
 "shape":"ChangeType",
 "documentation":"Type that indicates how a Changeset is applied to a Dataset. <ul> <li> <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded Changesets. </li> <li> <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded Changesets. </li> <li> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset. </li> </ul>"
 },
 "sourceParams":{
 "shape":"SourceParams",
 "documentation":"Options that define the location of the data being ingested."
 },
 "formatParams":{
 "shape":"FormatParams",
 "documentation":"Options that define the structure of the source file(s)."
 },
 "createTime":{
 "shape":"TimestampEpoch",
 "documentation":"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":{
 "shape":"IngestionStatus",
 "documentation":"Status of the Changeset ingestion. <ul> <li> <code>PENDING</code> - Changeset is pending creation. </li> <li> <code>FAILED</code> - Changeset creation has failed. </li> <li> <code>SUCCESS</code> - Changeset creation has succeeded. </li> <li> <code>RUNNING</code> - Changeset creation is running. </li> <li> <code>STOP_REQUESTED</code> - User requested Changeset creation to stop. </li> </ul>"
 },
 "errorInfo":{
 "shape":"ChangesetErrorInfo",
 "documentation":"The structure with error messages."
 },
 "activeUntilTimestamp":{
 "shape":"TimestampEpoch",
 "documentation":"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.",
 "box":true
 },
 "activeFromTimestamp":{
 "shape":"TimestampEpoch",
 "documentation":"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.",
 "box":true
 },
 "updatesChangesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier of the Changeset that is updated."
 },
 "updatedByChangesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier of the updated Changeset."
 }
 },
 "documentation":"A Changeset is unit of data in a Dataset."
 },
 "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":"Data type of a column. <ul> <li> <code>STRING</code> - A String data type. <code>CHAR</code> - A char data type. <code>INTEGER</code> - An integer data type. <code>TINYINT</code> - A tinyint data type. <code>SMALLINT</code> - A smallint data type. <code>BIGINT</code> - A bigint data type. <code>FLOAT</code> - A float data type. <code>DOUBLE</code> - A double data type. <code>DATE</code> - A date data type. <code>DATETIME</code> - A datetime data type. <code>BOOLEAN</code> - A boolean data type. <code>BINARY</code> - A binary data type. </li> </ul>"
 },
 "columnName":{
 "shape":"ColumnName",
 "documentation":"Name for a column."
 },
 "columnDescription":{
 "shape":"ColumnDescription",
 "documentation":"Description for a column."
 }
 },
 "documentation":"The definition of a column in a tabular Dataset."
 },
 "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":"The request conflicts with an existing resource.",
 "error":{"httpStatusCode":409},
 "exception":true
 },
 "CreateChangesetRequest":{
 "type":"structure",
 "required":[
 "datasetId",
 "changeType",
 "sourceParams",
 "formatParams"
 ],
 "members":{
 "clientToken":{
 "shape":"ClientToken",
 "documentation":"A token that ensures idempotency. This token expires in 10 minutes.",
 "idempotencyToken":true
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset where the Changeset will be created. ",
 "location":"uri",
 "locationName":"datasetId"
 },
 "changeType":{
 "shape":"ChangeType",
 "documentation":"Option to indicate how a Changeset will be applied to a Dataset. <ul> <li> <code>REPLACE</code> - Changeset will be considered as a replacement to all prior loaded Changesets. </li> <li> <code>APPEND</code> - Changeset will be considered as an addition to the end of all prior loaded Changesets. </li> <li> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset. </li> </ul>"
 },
 "sourceParams":{
 "shape":"SourceParams",
 "documentation":"Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>). Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes. Here is an example of how you could specify the <code>sourceParams</code>: <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> 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."
 },
 "formatParams":{
 "shape":"FormatParams",
 "documentation":"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>). <code>formatType</code> is a required attribute and can have the following values: <ul> <li> <code>PARQUET</code> - Parquet source file format. </li> <li> <code>CSV</code> - CSV source file format. </li> <li> <code>JSON</code> - JSON source file format. </li> <li> <code>XML</code> - XML source file format. </li> </ul> Here is an example of how you could specify the <code>formatParams</code>: <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> 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: <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> 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."
 }
 },
 "documentation":"The request for a CreateChangeset operation."
 },
 "CreateChangesetResponse":{
 "type":"structure",
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset where the Changeset is created."
 },
 "changesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier of the Changeset that is created."
 }
 },
 "documentation":"The response from a CreateChangeset operation."
 },
 "CreateDataViewRequest":{
 "type":"structure",
 "required":[
 "datasetId",
 "destinationTypeParams"
 ],
 "members":{
 "clientToken":{
 "shape":"ClientToken",
 "documentation":"A token that ensures idempotency. This token expires in 10 minutes.",
 "idempotencyToken":true
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique Dataset identifier that is used to create a Dataview.",
 "location":"uri",
 "locationName":"datasetId"
 },
 "autoUpdate":{
 "shape":"Boolean",
 "documentation":"Flag to indicate Dataview should be updated automatically."
 },
 "sortColumns":{
 "shape":"SortColumnList",
 "documentation":"Columns to be used for sorting the data."
 },
 "partitionColumns":{
 "shape":"PartitionColumnList",
 "documentation":"Ordered set of column names used to partition data."
 },
 "asOfTimestamp":{
 "shape":"TimestampEpoch",
 "documentation":"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.",
 "box":true
 },
 "destinationTypeParams":{
 "shape":"DataViewDestinationTypeParams",
 "documentation":"Options that define the destination type for the Dataview."
 }
 },
 "documentation":"Request for creating a data view."
 },
 "CreateDataViewResponse":{
 "type":"structure",
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier of the Dataset used for the Dataview."
 },
 "dataViewId":{
 "shape":"DataViewId",
 "documentation":"The unique identifier for the created Dataview."
 }
 },
 "documentation":"Response for creating a data view."
 },
 "CreateDatasetRequest":{
 "type":"structure",
 "required":[
 "datasetTitle",
 "kind",
 "permissionGroupParams"
 ],
 "members":{
 "clientToken":{
 "shape":"ClientToken",
 "documentation":"A token that ensures idempotency. This token expires in 10 minutes.",
 "idempotencyToken":true
 },
 "datasetTitle":{
 "shape":"DatasetTitle",
 "documentation":"Display title for a FinSpace Dataset."
 },
 "kind":{
 "shape":"DatasetKind",
 "documentation":"The format in which Dataset data is structured. <ul> <li> <code>TABULAR</code> - Data is structured in a tabular format. </li> <li> <code>NON_TABULAR</code> - Data is structured in a non-tabular format. </li> </ul>"
 },
 "datasetDescription":{
 "shape":"DatasetDescription",
 "documentation":"Description of a Dataset."
 },
 "ownerInfo":{
 "shape":"DatasetOwnerInfo",
 "documentation":"Contact information for a Dataset owner."
 },
 "permissionGroupParams":{
 "shape":"PermissionGroupParams",
 "documentation":"Permission group parameters for Dataset permissions."
 },
 "alias":{
 "shape":"AliasString",
 "documentation":"The unique resource identifier for a Dataset."
 },
 "schemaDefinition":{
 "shape":"SchemaUnion",
 "documentation":"Definition for a schema on a tabular Dataset."
 }
 },
 "documentation":"The request for a CreateDataset operation"
 },
 "CreateDatasetResponse":{
 "type":"structure",
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the created Dataset."
 }
 },
 "documentation":"The response from a CreateDataset operation"
 },
 "Credentials":{
 "type":"structure",
 "members":{
 "accessKeyId":{
 "shape":"stringValueLength1to255",
 "documentation":"The access key identifier."
 },
 "secretAccessKey":{
 "shape":"stringValueMaxLength1000",
 "documentation":"The access key."
 },
 "sessionToken":{
 "shape":"stringValueMaxLength1000",
 "documentation":"The session token."
 }
 },
 "documentation":"Short term API credentials."
 },
 "DataViewArn":{
 "type":"string",
 "documentation":"Arn of a DataView"
 },
 "DataViewDestinationType":{
 "type":"string",
 "documentation":"DataView Destination Type"
 },
 "DataViewDestinationTypeParams":{
 "type":"structure",
 "required":["destinationType"],
 "members":{
 "destinationType":{
 "shape":"DataViewDestinationType",
 "documentation":"Destination type for a Dataview. <ul> <li> <code>GLUE_TABLE</code> - Glue table destination type. </li> <li> <code>S3</code> - S3 destination type. </li> </ul>"
 },
 "s3DestinationExportFileFormat":{
 "shape":"ExportFileFormat",
 "documentation":"Data view export file format. <ul> <li> <code>PARQUET</code> - Parquet export file format. </li> <li> <code>DELIMITED_TEXT</code> - Delimited text export file format. </li> </ul>"
 },
 "s3DestinationExportFileFormatOptions":{
 "shape":"S3DestinationFormatOptions",
 "documentation":"Format Options for S3 Destination type. Here is an example of how you could specify the <code>s3DestinationExportFileFormatOptions</code> <code> { \"header\": \"true\", \"delimiter\": \",\", \"compression\": \"gzip\" }</code> "
 }
 },
 "documentation":"Structure for the Dataview destination type parameters."
 },
 "DataViewErrorInfo":{
 "type":"structure",
 "members":{
 "errorMessage":{
 "shape":"ErrorMessage",
 "documentation":"The text of the error message."
 },
 "errorCategory":{
 "shape":"ErrorCategory",
 "documentation":"The category of the error. <ul> <li> <code>VALIDATION</code> -The inputs to this request are invalid. </li> <li> <code>SERVICE_QUOTA_EXCEEDED</code> - Service quotas have been exceeded. Please contact AWS support to increase quotas. </li> <li> <code>ACCESS_DENIED</code> - Missing required permission to perform this request. </li> <li> <code>RESOURCE_NOT_FOUND</code> - One or more inputs to this request were not found. </li> <li> <code>THROTTLING</code> - The system temporarily lacks sufficient resources to process the request. </li> <li> <code>INTERNAL_SERVICE_EXCEPTION</code> - An internal service error has occurred. </li> <li> <code>CANCELLED</code> - Cancelled. </li> <li> <code>USER_RECOVERABLE</code> - A user recoverable error has occurred. </li> </ul>"
 }
 },
 "documentation":"The structure with error messages."
 },
 "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":"The unique identifier for the Dataview."
 },
 "dataViewArn":{
 "shape":"DataViewArn",
 "documentation":"The ARN identifier of the Dataview."
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"Th unique identifier for the Dataview Dataset."
 },
 "asOfTimestamp":{
 "shape":"TimestampEpoch",
 "documentation":"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.",
 "box":true
 },
 "partitionColumns":{
 "shape":"PartitionColumnList",
 "documentation":"Ordered set of column names used to partition data."
 },
 "sortColumns":{
 "shape":"SortColumnList",
 "documentation":"Columns to be used for sorting the data."
 },
 "status":{
 "shape":"DataViewStatus",
 "documentation":"The status of a Dataview creation. <ul> <li> <code>RUNNING</code> - Dataview creation is running. </li> <li> <code>STARTING</code> - Dataview creation is starting. </li> <li> <code>FAILED</code> - Dataview creation has failed. </li> <li> <code>CANCELLED</code> - Dataview creation has been cancelled. </li> <li> <code>TIMEOUT</code> - Dataview creation has timed out. </li> <li> <code>SUCCESS</code> - Dataview creation has succeeded. </li> <li> <code>PENDING</code> - Dataview creation is pending. </li> <li> <code>FAILED_CLEANUP_FAILED</code> - Dataview creation failed and resource cleanup failed. </li> </ul>"
 },
 "errorInfo":{
 "shape":"DataViewErrorInfo",
 "documentation":"The structure with error messages."
 },
 "destinationTypeProperties":{
 "shape":"DataViewDestinationTypeParams",
 "documentation":"Information about the Dataview destination."
 },
 "autoUpdate":{
 "shape":"Boolean",
 "documentation":"The flag to indicate Dataview should be updated automatically."
 },
 "createTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 },
 "lastModifiedTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 }
 },
 "documentation":"Structure for the summary of a Dataview."
 },
 "Dataset":{
 "type":"structure",
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"An identifier for a Dataset."
 },
 "datasetArn":{
 "shape":"DatasetArn",
 "documentation":"The ARN identifier of the Dataset."
 },
 "datasetTitle":{
 "shape":"DatasetTitle",
 "documentation":"Display title for a Dataset."
 },
 "kind":{
 "shape":"DatasetKind",
 "documentation":"The format in which Dataset data is structured. <ul> <li> <code>TABULAR</code> - Data is structured in a tabular format. </li> <li> <code>NON_TABULAR</code> - Data is structured in a non-tabular format. </li> </ul>"
 },
 "datasetDescription":{
 "shape":"DatasetDescription",
 "documentation":"Description for a Dataset."
 },
 "ownerInfo":{
 "shape":"DatasetOwnerInfo",
 "documentation":"Contact information for a Dataset owner."
 },
 "createTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 },
 "lastModifiedTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 },
 "schemaDefinition":{
 "shape":"SchemaUnion",
 "documentation":"Definition for a schema on a tabular Dataset."
 },
 "alias":{
 "shape":"AliasString",
 "documentation":"The unique resource identifier for a Dataset."
 }
 },
 "documentation":"The structure for a Dataset."
 },
 "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":"Name of the Dataset owner."
 },
 "phoneNumber":{
 "shape":"PhoneNumber",
 "documentation":"Phone number for the Dataset owner."
 },
 "email":{
 "shape":"Email",
 "documentation":"Email address for the Dataset owner."
 }
 },
 "documentation":"A structure for Dataset owner info."
 },
 "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":"A token that ensures idempotency. This token expires in 10 minutes.",
 "idempotencyToken":true,
 "location":"querystring",
 "locationName":"clientToken"
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier of the Dataset to be deleted.",
 "location":"uri",
 "locationName":"datasetId"
 }
 },
 "documentation":"The request for a DeleteDataset operation."
 },
 "DeleteDatasetResponse":{
 "type":"structure",
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the deleted Dataset."
 }
 },
 "documentation":"The response from an DeleteDataset operation"
 },
 "Email":{
 "type":"string",
 "documentation":"Email of Dataset Owner",
 "max":320,
 "min":4,
 "pattern":"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}"
 },
 "ErrorCategory":{
 "type":"string",
 "documentation":"Changeset Error Category",
 "enum":[
 "VALIDATION",
 "SERVICE_QUOTA_EXCEEDED",
 "ACCESS_DENIED",
 "RESOURCE_NOT_FOUND",
 "THROTTLING",
 "INTERNAL_SERVICE_EXCEPTION",
 "CANCELLED",
 "USER_RECOVERABLE"
 ]
 },
 "ErrorMessage":{
 "type":"string",
 "documentation":"Changeset Error Message",
 "max":1000
 },
 "ExportFileFormat":{
 "type":"string",
 "documentation":"Data View Export File Format",
 "enum":[
 "PARQUET",
 "DELIMITED_TEXT"
 ]
 },
 "FormatParams":{
 "type":"map",
 "key":{"shape":"StringMapKey"},
 "value":{"shape":"StringMapValue"},
 "documentation":"Format Parameters of a Changeset"
 },
 "GetChangesetRequest":{
 "type":"structure",
 "required":[
 "datasetId",
 "changesetId"
 ],
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset where the Changeset is created.",
 "location":"uri",
 "locationName":"datasetId"
 },
 "changesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier of the Changeset for which to get data.",
 "location":"uri",
 "locationName":"changesetId"
 }
 },
 "documentation":"Request to describe a changeset."
 },
 "GetChangesetResponse":{
 "type":"structure",
 "members":{
 "changesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier for a Changeset."
 },
 "changesetArn":{
 "shape":"ChangesetArn",
 "documentation":"The ARN identifier of the Changeset."
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset where the Changeset is created."
 },
 "changeType":{
 "shape":"ChangeType",
 "documentation":"Type that indicates how a Changeset is applied to a Dataset. <ul> <li> <code>REPLACE</code> - Changeset is considered as a replacement to all prior loaded Changesets. </li> <li> <code>APPEND</code> - Changeset is considered as an addition to the end of all prior loaded Changesets. </li> <li> <code>MODIFY</code> - Changeset is considered as a replacement to a specific prior ingested Changeset. </li> </ul>"
 },
 "sourceParams":{
 "shape":"SourceParams",
 "documentation":"Options that define the location of the data being ingested."
 },
 "formatParams":{
 "shape":"FormatParams",
 "documentation":"Structure of the source file(s)."
 },
 "createTime":{
 "shape":"TimestampEpoch",
 "documentation":"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":{
 "shape":"IngestionStatus",
 "documentation":"The status of Changeset creation operation."
 },
 "errorInfo":{
 "shape":"ChangesetErrorInfo",
 "documentation":"The structure with error messages."
 },
 "activeUntilTimestamp":{
 "shape":"TimestampEpoch",
 "documentation":"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.",
 "box":true
 },
 "activeFromTimestamp":{
 "shape":"TimestampEpoch",
 "documentation":"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.",
 "box":true
 },
 "updatesChangesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier of the Changeset that is being updated."
 },
 "updatedByChangesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier of the updated Changeset."
 }
 },
 "documentation":"The response from a describe changeset operation"
 },
 "GetDataViewRequest":{
 "type":"structure",
 "required":[
 "dataViewId",
 "datasetId"
 ],
 "members":{
 "dataViewId":{
 "shape":"DataViewId",
 "documentation":"The unique identifier for the Dataview.",
 "location":"uri",
 "locationName":"dataviewId"
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the Dataset used in the Dataview.",
 "location":"uri",
 "locationName":"datasetId"
 }
 },
 "documentation":"Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id."
 },
 "GetDataViewResponse":{
 "type":"structure",
 "members":{
 "autoUpdate":{
 "shape":"Boolean",
 "documentation":"Flag to indicate Dataview should be updated automatically."
 },
 "partitionColumns":{
 "shape":"PartitionColumnList",
 "documentation":"Ordered set of column names used to partition data."
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the Dataset used in the Dataview."
 },
 "asOfTimestamp":{
 "shape":"TimestampEpoch",
 "documentation":"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.",
 "box":true
 },
 "errorInfo":{
 "shape":"DataViewErrorInfo",
 "documentation":"Information about an error that occurred for the Dataview."
 },
 "lastModifiedTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 },
 "createTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 },
 "sortColumns":{
 "shape":"SortColumnList",
 "documentation":"Columns to be used for sorting the data."
 },
 "dataViewId":{
 "shape":"DataViewId",
 "documentation":"The unique identifier for the Dataview."
 },
 "dataViewArn":{
 "shape":"DataViewArn",
 "documentation":"The ARN identifier of the Dataview."
 },
 "destinationTypeParams":{
 "shape":"DataViewDestinationTypeParams",
 "documentation":"Options that define the destination type for the Dataview."
 },
 "status":{
 "shape":"DataViewStatus",
 "documentation":"The status of a Dataview creation. <ul> <li> <code>RUNNING</code> - Dataview creation is running. </li> <li> <code>STARTING</code> - Dataview creation is starting. </li> <li> <code>FAILED</code> - Dataview creation has failed. </li> <li> <code>CANCELLED</code> - Dataview creation has been cancelled. </li> <li> <code>TIMEOUT</code> - Dataview creation has timed out. </li> <li> <code>SUCCESS</code> - Dataview creation has succeeded. </li> <li> <code>PENDING</code> - Dataview creation is pending. </li> <li> <code>FAILED_CLEANUP_FAILED</code> - Dataview creation failed and resource cleanup failed. </li> </ul>"
 }
 },
 "documentation":"Response from retrieving a dataview, which includes details on the target database and table name"
 },
 "GetDatasetRequest":{
 "type":"structure",
 "required":["datasetId"],
 "members":{
 "datasetId":{
 "shape":"StringValueLength1to255",
 "documentation":"The unique identifier for a Dataset.",
 "location":"uri",
 "locationName":"datasetId"
 }
 },
 "documentation":"Request for the GetDataset operation."
 },
 "GetDatasetResponse":{
 "type":"structure",
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for a Dataset."
 },
 "datasetArn":{
 "shape":"DatasetArn",
 "documentation":"The ARN identifier of the Dataset."
 },
 "datasetTitle":{
 "shape":"DatasetTitle",
 "documentation":"Display title for a Dataset."
 },
 "kind":{
 "shape":"DatasetKind",
 "documentation":"The format in which Dataset data is structured. <ul> <li> <code>TABULAR</code> - Data is structured in a tabular format. </li> <li> <code>NON_TABULAR</code> - Data is structured in a non-tabular format. </li> </ul>"
 },
 "datasetDescription":{
 "shape":"DatasetDescription",
 "documentation":"A description of the Dataset."
 },
 "createTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 },
 "lastModifiedTime":{
 "shape":"TimestampEpoch",
 "documentation":"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."
 },
 "schemaDefinition":{
 "shape":"SchemaUnion",
 "documentation":"Definition for a schema on a tabular Dataset."
 },
 "alias":{
 "shape":"AliasString",
 "documentation":"The unique resource identifier for a Dataset."
 },
 "status":{
 "shape":"DatasetStatus",
 "documentation":"Status of the Dataset creation. <ul> <li> <code>PENDING</code> - Dataset is pending creation. </li> <li> <code>FAILED</code> - Dataset creation has failed. </li> <li> <code>SUCCESS</code> - Dataset creation has succeeded. </li> <li> <code>RUNNING</code> - Dataset creation is running. </li> </ul>"
 }
 },
 "documentation":"Response for the GetDataset operation"
 },
 "GetProgrammaticAccessCredentialsRequest":{
 "type":"structure",
 "required":["environmentId"],
 "members":{
 "durationInMinutes":{
 "shape":"SessionDuration",
 "documentation":"The time duration in which the credentials remain valid. ",
 "location":"querystring",
 "locationName":"durationInMinutes"
 },
 "environmentId":{
 "shape":"IdType",
 "documentation":"The FinSpace environment identifier.",
 "location":"querystring",
 "locationName":"environmentId"
 }
 },
 "documentation":"Request for GetProgrammaticAccessCredentials operation"
 },
 "GetProgrammaticAccessCredentialsResponse":{
 "type":"structure",
 "members":{
 "credentials":{
 "shape":"Credentials",
 "documentation":"Returns the programmatic credentials."
 },
 "durationInMinutes":{
 "shape":"SessionDuration",
 "documentation":"Returns the duration in which the credentials will remain valid."
 }
 },
 "documentation":"Response for GetProgrammaticAccessCredentials operation"
 },
 "GetWorkingLocationRequest":{
 "type":"structure",
 "members":{
 "locationType":{
 "shape":"locationType",
 "documentation":"Specify the type of the working location. <ul> <li> <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. </li> <li> <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. </li> </ul>"
 }
 }
 },
 "GetWorkingLocationResponse":{
 "type":"structure",
 "members":{
 "s3Uri":{
 "shape":"stringValueLength1to1024",
 "documentation":"Returns the Amazon S3 URI for the working location."
 },
 "s3Path":{
 "shape":"stringValueLength1to1024",
 "documentation":"Returns the Amazon S3 Path for the working location."
 },
 "s3Bucket":{
 "shape":"stringValueLength1to63",
 "documentation":"Returns the Amazon S3 bucket name for the working location."
 }
 }
 },
 "IdType":{
 "type":"string",
 "max":26,
 "min":1
 },
 "IngestionStatus":{
 "type":"string",
 "documentation":"Status of the ingestion process returned from scheduler service.",
 "enum":[
 "PENDING",
 "FAILED",
 "SUCCESS",
 "RUNNING",
 "STOP_REQUESTED"
 ]
 },
 "InternalServerException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"The request processing has failed because of an unknown error, exception or failure.",
 "error":{"httpStatusCode":500},
 "exception":true
 },
 "LimitExceededException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"A limit has exceeded.",
 "error":{"httpStatusCode":400},
 "exception":true
 },
 "ListChangesetsRequest":{
 "type":"structure",
 "required":["datasetId"],
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset to which the Changeset belongs.",
 "location":"uri",
 "locationName":"datasetId"
 },
 "maxResults":{
 "shape":"ResultLimit",
 "documentation":"The maximum number of results per page.",
 "box":true,
 "location":"querystring",
 "locationName":"maxResults"
 },
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"A token indicating where a results page should begin.",
 "location":"querystring",
 "locationName":"nextToken"
 }
 },
 "documentation":"Request to ListChangesetsRequest. It exposes minimal query filters."
 },
 "ListChangesetsResponse":{
 "type":"structure",
 "members":{
 "changesets":{
 "shape":"ChangesetList",
 "documentation":"List of Changesets found."
 },
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"A token indicating where a results page should begin."
 }
 },
 "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":"The unique identifier of the Dataset for which to retrieve Dataviews.",
 "location":"uri",
 "locationName":"datasetId"
 },
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"A token indicating where a results page should begin.",
 "location":"querystring",
 "locationName":"nextToken"
 },
 "maxResults":{
 "shape":"ResultLimit",
 "documentation":"The maximum number of results per page.",
 "box":true,
 "location":"querystring",
 "locationName":"maxResults"
 }
 },
 "documentation":"Request for a list data views."
 },
 "ListDataViewsResponse":{
 "type":"structure",
 "members":{
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"A token indicating where a results page should begin."
 },
 "dataViews":{
 "shape":"DataViewList",
 "documentation":"A list of Dataviews."
 }
 }
 },
 "ListDatasetsRequest":{
 "type":"structure",
 "members":{
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"A token indicating where a results page should begin.",
 "location":"querystring",
 "locationName":"nextToken"
 },
 "maxResults":{
 "shape":"ResultLimit",
 "documentation":"The maximum number of results per page.",
 "box":true,
 "location":"querystring",
 "locationName":"maxResults"
 }
 },
 "documentation":"Request for the ListDatasets operation."
 },
 "ListDatasetsResponse":{
 "type":"structure",
 "members":{
 "datasets":{
 "shape":"DatasetList",
 "documentation":"List of Datasets."
 },
 "nextToken":{
 "shape":"PaginationToken",
 "documentation":"A token indicating where a results page should begin."
 }
 },
 "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":"The unique identifier of the PermissionGroup."
 },
 "datasetPermissions":{
 "shape":"ResourcePermissionsList",
 "documentation":"List of resource permissions."
 }
 },
 "documentation":"Permission group parameters for Dataset permissions. Here is an example of how you could specify the <code>PermissionGroupParams</code>: <code> { \"permissionGroupId\": \"0r6fCRtSTUk4XPfXQe3M0g\", \"datasetPermissions\": [ {\"permission\": \"ViewDatasetDetails\"}, {\"permission\": \"AddDatasetData\"}, {\"permission\": \"EditDatasetMetadata\"}, {\"permission\": \"DeleteDataset\"} ] } </code> "
 },
 "PhoneNumber":{
 "type":"string",
 "documentation":"PhoneNumber of Dataset Owner",
 "max":20,
 "min":10,
 "pattern":"^[\\+0-9\\#\\,\$][\\+0-9\\-\\.\\/\\(\$\\,\\#\\s]+$"
 },
 "ResourceNotFoundException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"One or more resources can't be found.",
 "error":{"httpStatusCode":404},
 "exception":true
 },
 "ResourcePermission":{
 "type":"structure",
 "members":{
 "permission":{
 "shape":"StringValueLength1to250",
 "documentation":"Permission for a resource."
 }
 },
 "documentation":"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. The following is a list of valid dataset permissions that you can apply: <ul> <li> <code>ViewDatasetDetails</code> </li> <li> <code>ReadDatasetDetails</code> </li> <li> <code>AddDatasetData</code> </li> <li> <code>CreateSnapshot</code> </li> <li> <code>EditDatasetMetadata</code> </li> <li> <code>DeleteDataset</code> </li> </ul> 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."
 },
 "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":"List of column definitions."
 },
 "primaryKeyColumns":{
 "shape":"ColumnNameList",
 "documentation":"List of column names used for primary key."
 }
 },
 "documentation":"Definition for a schema on a tabular Dataset."
 },
 "SchemaUnion":{
 "type":"structure",
 "members":{
 "tabularSchemaConfig":{
 "shape":"SchemaDefinition",
 "documentation":"The configuration for a schema on a tabular Dataset."
 }
 },
 "documentation":"A union of schema types."
 },
 "SessionDuration":{
 "type":"long",
 "max":720,
 "min":60
 },
 "SortColumnList":{
 "type":"list",
 "member":{"shape":"StringValueLength1to255"},
 "documentation":"DataView Sort Column List"
 },
 "SourceParams":{
 "type":"map",
 "key":{"shape":"StringMapKey"},
 "value":{"shape":"StringMapValue"},
 "documentation":"Source Parameters of a Changeset"
 },
 "StringMapKey":{
 "type":"string",
 "max":128,
 "pattern":"[\\s\\S]*\\S[\\s\\S]*"
 },
 "StringMapValue":{
 "type":"string",
 "max":1000,
 "pattern":"[\\s\\S]*\\S[\\s\\S]*"
 },
 "StringValueLength1to250":{
 "type":"string",
 "documentation":"1 - 250 character String",
 "max":250,
 "min":1,
 "pattern":"[\\s\\S]*\\S[\\s\\S]*"
 },
 "StringValueLength1to255":{
 "type":"string",
 "documentation":"1 - 255 character String",
 "max":255,
 "min":1,
 "pattern":"[\\s\\S]*\\S[\\s\\S]*"
 },
 "ThrottlingException":{
 "type":"structure",
 "members":{
 },
 "documentation":"The request was denied due to request throttling.",
 "error":{"httpStatusCode":429},
 "exception":true
 },
 "TimestampEpoch":{
 "type":"long",
 "documentation":"Milliseconds since UTC epoch"
 },
 "UpdateChangesetRequest":{
 "type":"structure",
 "required":[
 "datasetId",
 "changesetId",
 "sourceParams",
 "formatParams"
 ],
 "members":{
 "clientToken":{
 "shape":"ClientToken",
 "documentation":"A token that ensures idempotency. This token expires in 10 minutes.",
 "idempotencyToken":true
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset in which the Changeset is created.",
 "location":"uri",
 "locationName":"datasetId"
 },
 "changesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier for the Changeset to update.",
 "location":"uri",
 "locationName":"changesetId"
 },
 "sourceParams":{
 "shape":"SourceParams",
 "documentation":"Options that define the location of the data being ingested (<code>s3SourcePath</code>) and the source of the changeset (<code>sourceType</code>). Both <code>s3SourcePath</code> and <code>sourceType</code> are required attributes. Here is an example of how you could specify the <code>sourceParams</code>: <code> \"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" } </code> 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."
 },
 "formatParams":{
 "shape":"FormatParams",
 "documentation":"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>). <code>formatType</code> is a required attribute and can have the following values: <ul> <li> <code>PARQUET</code> - Parquet source file format. </li> <li> <code>CSV</code> - CSV source file format. </li> <li> <code>JSON</code> - JSON source file format. </li> <li> <code>XML</code> - XML source file format. </li> </ul> Here is an example of how you could specify the <code>formatParams</code>: <code> \"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" } </code> 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: <code> { \"withHeader\": \"true\", \"separator\": \",\" } </code> 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."
 }
 },
 "documentation":"Request to update an existing changeset."
 },
 "UpdateChangesetResponse":{
 "type":"structure",
 "members":{
 "changesetId":{
 "shape":"ChangesetId",
 "documentation":"The unique identifier for the Changeset to update."
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the FinSpace Dataset in which the Changeset is created."
 }
 },
 "documentation":"The response from a update changeset operation."
 },
 "UpdateDatasetRequest":{
 "type":"structure",
 "required":[
 "datasetId",
 "datasetTitle",
 "kind"
 ],
 "members":{
 "clientToken":{
 "shape":"ClientToken",
 "documentation":"A token that ensures idempotency. This token expires in 10 minutes.",
 "idempotencyToken":true
 },
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for the Dataset to update.",
 "location":"uri",
 "locationName":"datasetId"
 },
 "datasetTitle":{
 "shape":"DatasetTitle",
 "documentation":"A display title for the Dataset."
 },
 "kind":{
 "shape":"DatasetKind",
 "documentation":"The format in which the Dataset data is structured. <ul> <li> <code>TABULAR</code> - Data is structured in a tabular format. </li> <li> <code>NON_TABULAR</code> - Data is structured in a non-tabular format. </li> </ul>"
 },
 "datasetDescription":{
 "shape":"DatasetDescription",
 "documentation":"A description for the Dataset."
 },
 "alias":{
 "shape":"AliasString",
 "documentation":"The unique resource identifier for a Dataset."
 },
 "schemaDefinition":{
 "shape":"SchemaUnion",
 "documentation":"Definition for a schema on a tabular Dataset."
 }
 },
 "documentation":"The request for an UpdateDataset operation"
 },
 "UpdateDatasetResponse":{
 "type":"structure",
 "members":{
 "datasetId":{
 "shape":"DatasetId",
 "documentation":"The unique identifier for updated Dataset."
 }
 },
 "documentation":"The response from an UpdateDataset operation"
 },
 "ValidationException":{
 "type":"structure",
 "members":{
 "message":{"shape":"errorMessage"}
 },
 "documentation":"The input fails to satisfy the constraints specified by an AWS service.",
 "error":{"httpStatusCode":400},
 "exception":true
 },
 "errorMessage":{"type":"string"},
 "locationType":{
 "type":"string",
 "enum":[
 "INGESTION",
 "SAGEMAKER"
 ]
 },
 "stringValueLength1to1024":{
 "type":"string",
 "max":1024,
 "min":1,
 "pattern":".*\\S.*"
 },
 "stringValueLength1to255":{
 "type":"string",
 "max":255,
 "min":1
 },
 "stringValueLength1to63":{
 "type":"string",
 "max":63,
 "min":1,
 "pattern":".*\\S.*"
 },
 "stringValueMaxLength1000":{
 "type":"string",
 "max":1000
 }
 },
 "documentation":" The FinSpace APIs let you take actions inside the FinSpace."
}