{ "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":{ "AssociateUserToPermissionGroup":{ "name":"AssociateUserToPermissionGroup", "http":{ "method":"POST", "requestUri":"/permission-group/{permissionGroupId}/users/{userId}" }, "input":{"shape":"AssociateUserToPermissionGroupRequest"}, "output":{"shape":"AssociateUserToPermissionGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "CreatePermissionGroup":{ "name":"CreatePermissionGroup", "http":{ "method":"POST", "requestUri":"/permission-group" }, "input":{"shape":"CreatePermissionGroupRequest"}, "output":{"shape":"CreatePermissionGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictException"} ], "documentation":"

Creates a group of permissions for various actions that a user can perform in FinSpace.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "CreateUser":{ "name":"CreateUser", "http":{ "method":"POST", "requestUri":"/user" }, "input":{"shape":"CreateUserRequest"}, "output":{"shape":"CreateUserResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictException"} ], "documentation":"

Creates a new user in FinSpace.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "DeletePermissionGroup":{ "name":"DeletePermissionGroup", "http":{ "method":"DELETE", "requestUri":"/permission-group/{permissionGroupId}" }, "input":{"shape":"DeletePermissionGroupRequest"}, "output":{"shape":"DeletePermissionGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictException"} ], "documentation":"

Deletes a permission group. This action is irreversible.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "DisableUser":{ "name":"DisableUser", "http":{ "method":"POST", "requestUri":"/user/{userId}/disable" }, "input":{"shape":"DisableUserRequest"}, "output":{"shape":"DisableUserResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Denies access to the FinSpace web application and API for the specified user.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "DisassociateUserFromPermissionGroup":{ "name":"DisassociateUserFromPermissionGroup", "http":{ "method":"DELETE", "requestUri":"/permission-group/{permissionGroupId}/users/{userId}" }, "input":{"shape":"DisassociateUserFromPermissionGroupRequest"}, "output":{"shape":"DisassociateUserFromPermissionGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Removes a user from a permission group.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "EnableUser":{ "name":"EnableUser", "http":{ "method":"POST", "requestUri":"/user/{userId}/enable" }, "input":{"shape":"EnableUserRequest"}, "output":{"shape":"EnableUserResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"LimitExceededException"}, {"shape":"ConflictException"} ], "documentation":"

Allows the specified user to access the FinSpace web application and API.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "GetExternalDataViewAccessDetails":{ "name":"GetExternalDataViewAccessDetails", "http":{ "method":"POST", "requestUri":"/datasets/{datasetId}/dataviewsv2/{dataviewId}/external-access-details" }, "input":{"shape":"GetExternalDataViewAccessDetailsRequest"}, "output":{"shape":"GetExternalDataViewAccessDetailsResponse"}, "errors":[ {"shape":"ResourceNotFoundException"}, {"shape":"InternalServerException"}, {"shape":"ThrottlingException"}, {"shape":"ValidationException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Returns the credentials to access the external Dataview from an S3 location. To call this API:

- You must retrieve the programmatic credentials.

- You must be a member of a FinSpace user group, where the dataset that you want to access has `Read Dataset Data` permissions.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "GetPermissionGroup":{ "name":"GetPermissionGroup", "http":{ "method":"GET", "requestUri":"/permission-group/{permissionGroupId}" }, "input":{"shape":"GetPermissionGroupRequest"}, "output":{"shape":"GetPermissionGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves the details of a specific permission group.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "GetUser":{ "name":"GetUser", "http":{ "method":"GET", "requestUri":"/user/{userId}" }, "input":{"shape":"GetUserRequest"}, "output":{"shape":"GetUserResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Retrieves details for a specific user.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "ListPermissionGroups":{ "name":"ListPermissionGroups", "http":{ "method":"GET", "requestUri":"/permission-group" }, "input":{"shape":"ListPermissionGroupsRequest"}, "output":{"shape":"ListPermissionGroupsResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists all available permission groups in FinSpace.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "ListPermissionGroupsByUser":{ "name":"ListPermissionGroupsByUser", "http":{ "method":"GET", "requestUri":"/user/{userId}/permission-groups" }, "input":{"shape":"ListPermissionGroupsByUserRequest"}, "output":{"shape":"ListPermissionGroupsByUserResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists all the permission groups that are associated with a specific user.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "ListUsers":{ "name":"ListUsers", "http":{ "method":"GET", "requestUri":"/user" }, "input":{"shape":"ListUsersRequest"}, "output":{"shape":"ListUsersResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"} ], "documentation":"

Lists all available users in FinSpace.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "ListUsersByPermissionGroup":{ "name":"ListUsersByPermissionGroup", "http":{ "method":"GET", "requestUri":"/permission-group/{permissionGroupId}/users" }, "input":{"shape":"ListUsersByPermissionGroupRequest"}, "output":{"shape":"ListUsersByPermissionGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"} ], "documentation":"

Lists details of all the users in a specific permission group.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "ResetUserPassword":{ "name":"ResetUserPassword", "http":{ "method":"POST", "requestUri":"/user/{userId}/password" }, "input":{"shape":"ResetUserPasswordRequest"}, "output":{"shape":"ResetUserPasswordResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "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.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "UpdatePermissionGroup":{ "name":"UpdatePermissionGroup", "http":{ "method":"PUT", "requestUri":"/permission-group/{permissionGroupId}" }, "input":{"shape":"UpdatePermissionGroupRequest"}, "output":{"shape":"UpdatePermissionGroupResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Modifies the details of a permission group. You cannot modify a `permissionGroupID`.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." }, "UpdateUser":{ "name":"UpdateUser", "http":{ "method":"PUT", "requestUri":"/user/{userId}" }, "input":{"shape":"UpdateUserRequest"}, "output":{"shape":"UpdateUserResponse"}, "errors":[ {"shape":"InternalServerException"}, {"shape":"ValidationException"}, {"shape":"ThrottlingException"}, {"shape":"AccessDeniedException"}, {"shape":"ResourceNotFoundException"}, {"shape":"ConflictException"} ], "documentation":"

Modifies the details of the specified user. You cannot update the `userId` for a user.

", "deprecated":true, "deprecatedMessage":"This method will be discontinued." } }, "shapes":{ "AccessDeniedException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"} }, "documentation":"

You do not have sufficient access to perform this action.

", "error":{"httpStatusCode":403}, "exception":true }, "AccessKeyId":{ "type":"string", "max":255, "min":1, "pattern":"[\\s\\S]*\\S[\\s\\S]*" }, "AliasString":{ "type":"string", "max":255, "min":1, "pattern":"^alias\\/\\S+" }, "ApiAccess":{ "type":"string", "enum":[ "ENABLED", "DISABLED" ] }, "ApplicationPermission":{ "type":"string", "enum":[ "CreateDataset", "ManageClusters", "ManageUsersAndGroups", "ManageAttributeSets", "ViewAuditData", "AccessNotebooks", "GetTemporaryCredentials" ] }, "ApplicationPermissionList":{ "type":"list", "member":{"shape":"ApplicationPermission"} }, "AssociateUserToPermissionGroupRequest":{ "type":"structure", "required":[ "permissionGroupId", "userId" ], "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group.

", "location":"uri", "locationName":"permissionGroupId" }, "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user.

", "location":"uri", "locationName":"userId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "AssociateUserToPermissionGroupResponse":{ "type":"structure", "members":{ "statusCode":{ "shape":"StatusCode", "documentation":"

The returned status code of the response.

", "location":"statusCode" } } }, "AwsCredentials":{ "type":"structure", "members":{ "accessKeyId":{ "shape":"AccessKeyId", "documentation":"

The unique identifier for the security credentials.

" }, "secretAccessKey":{ "shape":"SecretAccessKey", "documentation":"

The secret access key that can be used to sign requests.

" }, "sessionToken":{ "shape":"SessionToken", "documentation":"

The token that users must pass to use the credentials.

" }, "expiration":{ "shape":"TimestampEpoch", "documentation":"

The Epoch time when the current credentials expire.

" } }, "documentation":"

The credentials required to access the external Dataview from the S3 location.

", "sensitive":true }, "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.

- `VALIDATION` – The inputs to this request are invalid.

- `SERVICE_QUOTA_EXCEEDED` – Service quotas have been exceeded. Please contact AWS support to increase quotas.

- `ACCESS_DENIED` – Missing required permission to perform this request.

- `RESOURCE_NOT_FOUND` – One or more inputs to this request were not found.

- `THROTTLING` – The system temporarily lacks sufficient resources to process the request.

- `INTERNAL_SERVICE_EXCEPTION` – An internal service error has occurred.

- `CANCELLED` – Cancelled.

- `USER_RECOVERABLE` – A user recoverable error has occurred.

" } }, "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.

- `REPLACE` – Changeset is considered as a replacement to all prior loaded Changesets.

- `APPEND` – Changeset is considered as an addition to the end of all prior loaded Changesets.

- `MODIFY` – Changeset is considered as a replacement to a specific prior ingested Changeset.

" }, "sourceParams":{ "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.

- `PENDING` – Changeset is pending creation.

- `FAILED` – Changeset creation has failed.

- `SUCCESS` – Changeset creation has succeeded.

- `RUNNING` – Changeset creation is running.

- `STOP_REQUESTED` – User requested Changeset creation to stop.

" }, "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.

- `STRING` – A String data type.

  `CHAR` – A char data type.

  `INTEGER` – An integer data type.

  `TINYINT` – A tinyint data type.

  `SMALLINT` – A smallint data type.

  `BIGINT` – A bigint data type.

  `FLOAT` – A float data type.

  `DOUBLE` – A double data type.

  `DATE` – A date data type.

  `DATETIME` – A datetime data type.

  `BOOLEAN` – A boolean data type.

  `BINARY` – A binary data type.

" }, "columnName":{ "shape":"ColumnName", "documentation":"

The name of 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]*" }, "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"}, "reason":{"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":"

The option to indicate how a Changeset will be applied to a Dataset.

- `REPLACE` – Changeset will be considered as a replacement to all prior loaded Changesets.

- `APPEND` – Changeset will be considered as an addition to the end of all prior loaded Changesets.

- `MODIFY` – Changeset is considered as a replacement to a specific prior ingested Changeset.

" }, "sourceParams":{ "shape":"SourceParams", "documentation":"

Options that define the location of the data being ingested (`s3SourcePath`) and the source of the changeset (`sourceType`).

Both `s3SourcePath` and `sourceType` are required attributes.

Here is an example of how you could specify the `sourceParams`:

`\"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" }`

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 Loading data from an Amazon S3 Bucket using the FinSpace API section.

" }, "formatParams":{ "shape":"FormatParams", "documentation":"

Options that define the structure of the source file(s) including the format type (`formatType`), header row (`withHeader`), data separation character (`separator`) and the type of compression (`compression`).

`formatType` is a required attribute and can have the following values:

- `PARQUET` – Parquet source file format.

- `CSV` – CSV source file format.

- `JSON` – JSON source file format.

- `XML` – XML source file format.

Here is an example of how you could specify the `formatParams`:

`\"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" }`

Note that if you only provide `formatType` as `CSV`, the rest of the attributes will automatically default to CSV values as following:

`{ \"withHeader\": \"true\", \"separator\": \",\" }`

For more information about supported file formats, see Supported Data Types and File Formats 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.

- `TABULAR` – Data is structured in a tabular format.

- `NON_TABULAR` – Data is structured in a non-tabular format.

" }, "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" }, "CreatePermissionGroupRequest":{ "type":"structure", "required":[ "name", "applicationPermissions" ], "members":{ "name":{ "shape":"PermissionGroupName", "documentation":"

The name of the permission group.

" }, "description":{ "shape":"PermissionGroupDescription", "documentation":"

A brief description for the permission group.

" }, "applicationPermissions":{ "shape":"ApplicationPermissionList", "documentation":"

The option to indicate FinSpace application permissions that are granted to a specific group.

When assigning application permissions, be aware that the permission `ManageUsersAndGroups` allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

- `CreateDataset` – Group members can create new datasets.

- `ManageClusters` – Group members can manage Apache Spark clusters from FinSpace notebooks.

- `ManageUsersAndGroups` – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

- `ManageAttributeSets` – Group members can manage attribute sets.

- `ViewAuditData` – Group members can view audit data.

- `AccessNotebooks` – Group members will have access to FinSpace notebooks.

- `GetTemporaryCredentials` – Group members can get temporary API credentials.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "CreatePermissionGroupResponse":{ "type":"structure", "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group.

" } } }, "CreateUserRequest":{ "type":"structure", "required":[ "emailAddress", "type" ], "members":{ "emailAddress":{ "shape":"Email", "documentation":"

The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

" }, "type":{ "shape":"UserType", "documentation":"

The option to indicate the type of user. Use one of the following options to specify this parameter:

- `SUPER_USER` – A user with permission to all the functionality and data in FinSpace.

- `APP_USER` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

" }, "firstName":{ "shape":"FirstName", "documentation":"

The first name of the user that you want to register.

" }, "lastName":{ "shape":"LastName", "documentation":"

The last name of the user that you want to register.

" }, "apiAccess":{ "shape":"ApiAccess", "documentation":"

The option to indicate whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.

- `ENABLED` – The user has permissions to use the APIs.

- `DISABLED` – The user does not have permissions to use any APIs.

" }, "apiAccessPrincipalArn":{ "shape":"RoleArn", "documentation":"

The ARN identifier of an AWS user or role that is allowed to call the `GetProgrammaticAccessCredentials` API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "CreateUserResponse":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user.

" } } }, "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.

", "sensitive":true }, "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.

- `GLUE_TABLE` – Glue table destination type.

- `S3` – S3 destination type.

" }, "s3DestinationExportFileFormat":{ "shape":"ExportFileFormat", "documentation":"

Dataview export file format.

- `PARQUET` – Parquet export file format.

- `DELIMITED_TEXT` – Delimited text export file format.

" }, "s3DestinationExportFileFormatOptions":{ "shape":"S3DestinationFormatOptions", "documentation":"

Format Options for S3 Destination type.

Here is an example of how you could specify the `s3DestinationExportFileFormatOptions`

`{ \"header\": \"true\", \"delimiter\": \",\", \"compression\": \"gzip\" }`

" } }, "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.

- `VALIDATION` – The inputs to this request are invalid.

- `SERVICE_QUOTA_EXCEEDED` – Service quotas have been exceeded. Please contact AWS support to increase quotas.

- `ACCESS_DENIED` – Missing required permission to perform this request.

- `RESOURCE_NOT_FOUND` – One or more inputs to this request were not found.

- `THROTTLING` – The system temporarily lacks sufficient resources to process the request.

- `INTERNAL_SERVICE_EXCEPTION` – An internal service error has occurred.

- `CANCELLED` – Cancelled.

- `USER_RECOVERABLE` – A user recoverable error has occurred.

" } }, "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.

- `RUNNING` – Dataview creation is running.

- `STARTING` – Dataview creation is starting.

- `FAILED` – Dataview creation has failed.

- `CANCELLED` – Dataview creation has been cancelled.

- `TIMEOUT` – Dataview creation has timed out.

- `SUCCESS` – Dataview creation has succeeded.

- `PENDING` – Dataview creation is pending.

- `FAILED_CLEANUP_FAILED` – Dataview creation failed and resource cleanup failed.

" }, "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.

- `TABULAR` – Data is structured in a tabular format.

- `NON_TABULAR` – Data is structured in a non-tabular format.

" }, "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, "pattern":"[\\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":"

The 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" }, "DeletePermissionGroupRequest":{ "type":"structure", "required":["permissionGroupId"], "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group that you want to delete.

", "location":"uri", "locationName":"permissionGroupId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DeletePermissionGroupResponse":{ "type":"structure", "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the deleted permission group.

" } } }, "DisableUserRequest":{ "type":"structure", "required":["userId"], "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user that you want to deactivate.

", "location":"uri", "locationName":"userId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "DisableUserResponse":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the deactivated user.

" } } }, "DisassociateUserFromPermissionGroupRequest":{ "type":"structure", "required":[ "permissionGroupId", "userId" ], "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group.

", "location":"uri", "locationName":"permissionGroupId" }, "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user.

", "location":"uri", "locationName":"userId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true, "location":"querystring", "locationName":"clientToken" } } }, "DisassociateUserFromPermissionGroupResponse":{ "type":"structure", "members":{ "statusCode":{ "shape":"StatusCode", "documentation":"

The returned status code of the response.

", "location":"statusCode" } } }, "Email":{ "type":"string", "max":320, "min":4, "pattern":"[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\\.[A-Za-z]{2,4}", "sensitive":true }, "EnableUserRequest":{ "type":"structure", "required":["userId"], "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user that you want to activate.

", "location":"uri", "locationName":"userId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "EnableUserResponse":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the active user.

" } } }, "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" ] }, "FirstName":{ "type":"string", "max":50, "min":1, "pattern":".*\\S.*", "sensitive":true }, "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.

- `REPLACE` – Changeset is considered as a replacement to all prior loaded Changesets.

- `APPEND` – Changeset is considered as an addition to the end of all prior loaded Changesets.

- `MODIFY` – Changeset is considered as a replacement to a specific prior ingested Changeset.

" }, "sourceParams":{ "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.

- `RUNNING` – Dataview creation is running.

- `STARTING` – Dataview creation is starting.

- `FAILED` – Dataview creation has failed.

- `CANCELLED` – Dataview creation has been cancelled.

- `TIMEOUT` – Dataview creation has timed out.

- `SUCCESS` – Dataview creation has succeeded.

- `PENDING` – Dataview creation is pending.

- `FAILED_CLEANUP_FAILED` – Dataview creation failed and resource cleanup failed.

" } }, "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.

- `TABULAR` – Data is structured in a tabular format.

- `NON_TABULAR` – Data is structured in a non-tabular format.

" }, "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.

- `PENDING` – Dataset is pending creation.

- `FAILED` – Dataset creation has failed.

- `SUCCESS` – Dataset creation has succeeded.

- `RUNNING` – Dataset creation is running.

" } }, "documentation":"Response for the GetDataset operation" }, "GetExternalDataViewAccessDetailsRequest":{ "type":"structure", "required":[ "dataViewId", "datasetId" ], "members":{ "dataViewId":{ "shape":"DataViewId", "documentation":"

The unique identifier for the Dataview that you want to access.

", "location":"uri", "locationName":"dataviewId" }, "datasetId":{ "shape":"DatasetId", "documentation":"

The unique identifier for the Dataset.

", "location":"uri", "locationName":"datasetId" } } }, "GetExternalDataViewAccessDetailsResponse":{ "type":"structure", "members":{ "credentials":{ "shape":"AwsCredentials", "documentation":"

The credentials required to access the external Dataview from the S3 location.

" }, "s3Location":{ "shape":"S3Location", "documentation":"

The location where the external Dataview is stored.

" } } }, "GetPermissionGroupRequest":{ "type":"structure", "required":["permissionGroupId"], "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group.

", "location":"uri", "locationName":"permissionGroupId" } } }, "GetPermissionGroupResponse":{ "type":"structure", "members":{ "permissionGroup":{"shape":"PermissionGroup"} } }, "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" }, "GetUserRequest":{ "type":"structure", "required":["userId"], "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier of the user to get data for.

", "location":"uri", "locationName":"userId" } } }, "GetUserResponse":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user that is retrieved.

" }, "status":{ "shape":"UserStatus", "documentation":"

The current status of the user.

- `CREATING` – The creation is in progress.

- `ENABLED` – The user is created and is currently active.

- `DISABLED` – The user is currently inactive.

" }, "firstName":{ "shape":"FirstName", "documentation":"

The first name of the user.

" }, "lastName":{ "shape":"LastName", "documentation":"

The last name of the user.

" }, "emailAddress":{ "shape":"Email", "documentation":"

The email address that is associated with the user.

" }, "type":{ "shape":"UserType", "documentation":"

Indicates the type of user.

- `SUPER_USER` – A user with permission to all the functionality and data in FinSpace.

- `APP_USER` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

" }, "apiAccess":{ "shape":"ApiAccess", "documentation":"

Indicates whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.

- `ENABLED` – The user has permissions to use the APIs.

- `DISABLED` – The user does not have permissions to use any APIs.

" }, "apiAccessPrincipalArn":{ "shape":"RoleArn", "documentation":"

The ARN identifier of an AWS user or role that is allowed to call the `GetProgrammaticAccessCredentials` API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" }, "createTime":{ "shape":"TimestampEpoch", "documentation":"

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

" }, "lastEnabledTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

" }, "lastDisabledTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

" }, "lastModifiedTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.

" }, "lastLoginTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

" } } }, "GetWorkingLocationRequest":{ "type":"structure", "members":{ "locationType":{ "shape":"locationType", "documentation":"

Specify the type of the working location.

- `SAGEMAKER` – Use the Amazon S3 location as a temporary location to store data content when working with FinSpace Notebooks that run on SageMaker studio.

- `INGESTION` – Use the Amazon S3 location as a staging location to copy your data content and then use the location with the Changeset creation operation.

" } } }, "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 }, "LastName":{ "type":"string", "max":50, "min":1, "pattern":".*\\S.*", "sensitive":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 that indicates 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 that indicates 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 that indicates 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 that indicates where a results page should begin.

" }, "dataViews":{ "shape":"DataViewList", "documentation":"

A list of Dataviews.

" } } }, "ListDatasetsRequest":{ "type":"structure", "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates 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 that indicates where a results page should begin.

" } }, "documentation":"Response for the ListDatasets operation" }, "ListPermissionGroupsByUserRequest":{ "type":"structure", "required":[ "userId", "maxResults" ], "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user.

", "location":"uri", "locationName":"userId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ResultLimit", "documentation":"

The maximum number of results per page.

", "location":"querystring", "locationName":"maxResults" } } }, "ListPermissionGroupsByUserResponse":{ "type":"structure", "members":{ "permissionGroups":{ "shape":"PermissionGroupByUserList", "documentation":"

A list of returned permission groups.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

" } } }, "ListPermissionGroupsRequest":{ "type":"structure", "required":["maxResults"], "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ResultLimit", "documentation":"

The maximum number of results per page.

", "location":"querystring", "locationName":"maxResults" } } }, "ListPermissionGroupsResponse":{ "type":"structure", "members":{ "permissionGroups":{ "shape":"PermissionGroupList", "documentation":"

A list of all the permission groups.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

" } } }, "ListUsersByPermissionGroupRequest":{ "type":"structure", "required":[ "permissionGroupId", "maxResults" ], "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group.

", "location":"uri", "locationName":"permissionGroupId" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ResultLimit", "documentation":"

The maximum number of results per page.

", "location":"querystring", "locationName":"maxResults" } } }, "ListUsersByPermissionGroupResponse":{ "type":"structure", "members":{ "users":{ "shape":"UserByPermissionGroupList", "documentation":"

Lists details of all users in a specific permission group.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

" } } }, "ListUsersRequest":{ "type":"structure", "required":["maxResults"], "members":{ "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

", "location":"querystring", "locationName":"nextToken" }, "maxResults":{ "shape":"ResultLimit", "documentation":"

The maximum number of results per page.

", "location":"querystring", "locationName":"maxResults" } } }, "ListUsersResponse":{ "type":"structure", "members":{ "users":{ "shape":"UserList", "documentation":"

A list of all the users.

" }, "nextToken":{ "shape":"PaginationToken", "documentation":"

A token that indicates where a results page should begin.

" } } }, "OwnerName":{ "type":"string", "documentation":"1 - 250 character String", "max":250, "min":1, "pattern":".*\\S.*" }, "PaginationToken":{"type":"string"}, "PartitionColumnList":{ "type":"list", "member":{"shape":"StringValueLength1to255"}, "documentation":"DataView Partition Column List" }, "Password":{ "type":"string", "max":20, "min":8, "pattern":".*\\S.*", "sensitive":true }, "PermissionGroup":{ "type":"structure", "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group.

" }, "name":{ "shape":"PermissionGroupName", "documentation":"

The name of the permission group.

" }, "description":{ "shape":"PermissionGroupDescription", "documentation":"

A brief description for the permission group.

" }, "applicationPermissions":{ "shape":"ApplicationPermissionList", "documentation":"

Indicates the permissions that are granted to a specific group for accessing the FinSpace application.

When assigning application permissions, be aware that the permission `ManageUsersAndGroups` allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

- `CreateDataset` – Group members can create new datasets.

- `ManageClusters` – Group members can manage Apache Spark clusters from FinSpace notebooks.

- `ManageUsersAndGroups` – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

- `ManageAttributeSets` – Group members can manage attribute sets.

- `ViewAuditData` – Group members can view audit data.

- `AccessNotebooks` – Group members will have access to FinSpace notebooks.

- `GetTemporaryCredentials` – Group members can get temporary API credentials.

" }, "createTime":{ "shape":"TimestampEpoch", "documentation":"

The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.

" }, "lastModifiedTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.

" }, "membershipStatus":{ "shape":"PermissionGroupMembershipStatus", "documentation":"

Indicates the status of the user within a permission group.

- `ADDITION_IN_PROGRESS` – The user is currently being added to the permission group.

- `ADDITION_SUCCESS` – The user is successfully added to the permission group.

- `REMOVAL_IN_PROGRESS` – The user is currently being removed from the permission group.

" } }, "documentation":"

The structure for a permission group.

" }, "PermissionGroupByUser":{ "type":"structure", "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group.

" }, "name":{ "shape":"PermissionGroupName", "documentation":"

The name of the permission group.

" }, "membershipStatus":{ "shape":"PermissionGroupMembershipStatus", "documentation":"

Indicates the status of the user within a permission group.

- `ADDITION_IN_PROGRESS` – The user is currently being added to the permission group.

- `ADDITION_SUCCESS` – The user is successfully added to the permission group.

- `REMOVAL_IN_PROGRESS` – The user is currently being removed from the permission group.

" } }, "documentation":"

The structure of a permission group associated with a user.

" }, "PermissionGroupByUserList":{ "type":"list", "member":{"shape":"PermissionGroupByUser"} }, "PermissionGroupDescription":{ "type":"string", "max":4000, "min":1, "pattern":"[\\s\\S]*", "sensitive":true }, "PermissionGroupId":{ "type":"string", "max":26, "min":1, "pattern":".*\\S.*" }, "PermissionGroupList":{ "type":"list", "member":{"shape":"PermissionGroup"} }, "PermissionGroupMembershipStatus":{ "type":"string", "enum":[ "ADDITION_IN_PROGRESS", "ADDITION_SUCCESS", "REMOVAL_IN_PROGRESS" ] }, "PermissionGroupName":{ "type":"string", "max":255, "min":1, "pattern":".*\\S.*", "sensitive":true }, "PermissionGroupParams":{ "type":"structure", "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for 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 `PermissionGroupParams`:

`{ \"permissionGroupId\": \"0r6fCRtSTUk4XPfXQe3M0g\", \"datasetPermissions\": [ {\"permission\": \"ViewDatasetDetails\"}, {\"permission\": \"AddDatasetData\"}, {\"permission\": \"EditDatasetMetadata\"}, {\"permission\": \"DeleteDataset\"} ] }`

" }, "PhoneNumber":{ "type":"string", "documentation":"PhoneNumber of Dataset Owner", "max":20, "min":10, "pattern":"^[\\+0-9\\#\\,\\(][\\+0-9\\-\\.\\/\\(\\)\\,\\#\\s]+$" }, "ResetUserPasswordRequest":{ "type":"structure", "required":["userId"], "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier of the user that a temporary password is requested for.

", "location":"uri", "locationName":"userId" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "ResetUserPasswordResponse":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier of the user that a new password is generated for.

" }, "temporaryPassword":{ "shape":"Password", "documentation":"

A randomly generated temporary password for the requested user. This password expires in 7 days.

" } } }, "ResourceNotFoundException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"}, "reason":{"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:

- `ViewDatasetDetails`

- `ReadDatasetDetails`

- `AddDatasetData`

- `CreateDataView`

- `EditDatasetMetadata`

- `DeleteDataset`

For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.

" }, "ResourcePermissionsList":{ "type":"list", "member":{"shape":"ResourcePermission"}, "documentation":"List of Resource Permissions" }, "ResultLimit":{ "type":"integer", "max":100, "min":1 }, "RoleArn":{ "type":"string", "max":2048, "min":20, "pattern":"^arn:aws[a-z\\-]*:iam::\\d{12}:role/?[a-zA-Z_0-9+=,.@\\-_/]+$" }, "S3BucketName":{ "type":"string", "max":63, "min":1, "pattern":"^.*\\S.*$" }, "S3DestinationFormatOptions":{ "type":"map", "key":{"shape":"StringMapKey"}, "value":{"shape":"StringMapValue"} }, "S3Key":{ "type":"string", "max":1024, "min":1, "pattern":"^.*\\S.*$" }, "S3Location":{ "type":"structure", "required":[ "bucket", "key" ], "members":{ "bucket":{ "shape":"S3BucketName", "documentation":"

The name of the S3 bucket.

" }, "key":{ "shape":"S3Key", "documentation":"

The path of the folder, within the S3 bucket that contains the Dataset.

" } }, "documentation":"

The location of an external Dataview in an S3 bucket.

" }, "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.

" }, "SecretAccessKey":{ "type":"string", "max":1000, "min":1, "pattern":"[\\s\\S]*\\S[\\s\\S]*", "sensitive":true }, "SessionDuration":{ "type":"long", "max":60, "min":1 }, "SessionToken":{ "type":"string", "max":1000, "min":1, "pattern":"[\\s\\S]*\\S[\\s\\S]*", "sensitive":true }, "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" }, "StatusCode":{"type":"integer"}, "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 (`s3SourcePath`) and the source of the changeset (`sourceType`).

Both `s3SourcePath` and `sourceType` are required attributes.

Here is an example of how you could specify the `sourceParams`:

`\"sourceParams\": { \"s3SourcePath\": \"s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv\", \"sourceType\": \"S3\" }`

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 Loading data from an Amazon S3 Bucket using the FinSpace APIsection.

" }, "formatParams":{ "shape":"FormatParams", "documentation":"

Options that define the structure of the source file(s) including the format type (`formatType`), header row (`withHeader`), data separation character (`separator`) and the type of compression (`compression`).

`formatType` is a required attribute and can have the following values:

- `PARQUET` – Parquet source file format.

- `CSV` – CSV source file format.

- `JSON` – JSON source file format.

- `XML` – XML source file format.

Here is an example of how you could specify the `formatParams`:

`\"formatParams\": { \"formatType\": \"CSV\", \"withHeader\": \"true\", \"separator\": \",\", \"compression\":\"None\" }`

Note that if you only provide `formatType` as `CSV`, the rest of the attributes will automatically default to CSV values as following:

`{ \"withHeader\": \"true\", \"separator\": \",\" }`

For more information about supported file formats, see Supported Data Types and File Formats 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.

- `TABULAR` – Data is structured in a tabular format.

- `NON_TABULAR` – Data is structured in a non-tabular format.

" }, "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" }, "UpdatePermissionGroupRequest":{ "type":"structure", "required":["permissionGroupId"], "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the permission group to update.

", "location":"uri", "locationName":"permissionGroupId" }, "name":{ "shape":"PermissionGroupName", "documentation":"

The name of the permission group.

" }, "description":{ "shape":"PermissionGroupDescription", "documentation":"

A brief description for the permission group.

" }, "applicationPermissions":{ "shape":"ApplicationPermissionList", "documentation":"

The permissions that are granted to a specific group for accessing the FinSpace application.

When assigning application permissions, be aware that the permission `ManageUsersAndGroups` allows users to grant themselves or others access to any functionality in their FinSpace environment's application. It should only be granted to trusted users.

- `CreateDataset` – Group members can create new datasets.

- `ManageClusters` – Group members can manage Apache Spark clusters from FinSpace notebooks.

- `ManageUsersAndGroups` – Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.

- `ManageAttributeSets` – Group members can manage attribute sets.

- `ViewAuditData` – Group members can view audit data.

- `AccessNotebooks` – Group members will have access to FinSpace notebooks.

- `GetTemporaryCredentials` – Group members can get temporary API credentials.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "UpdatePermissionGroupResponse":{ "type":"structure", "members":{ "permissionGroupId":{ "shape":"PermissionGroupId", "documentation":"

The unique identifier for the updated permission group.

" } } }, "UpdateUserRequest":{ "type":"structure", "required":["userId"], "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user that you want to update.

", "location":"uri", "locationName":"userId" }, "type":{ "shape":"UserType", "documentation":"

The option to indicate the type of user.

- `SUPER_USER`– A user with permission to all the functionality and data in FinSpace.

- `APP_USER` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

" }, "firstName":{ "shape":"FirstName", "documentation":"

The first name of the user.

" }, "lastName":{ "shape":"LastName", "documentation":"

The last name of the user.

" }, "apiAccess":{ "shape":"ApiAccess", "documentation":"

The option to indicate whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.

- `ENABLED` – The user has permissions to use the APIs.

- `DISABLED` – The user does not have permissions to use any APIs.

" }, "apiAccessPrincipalArn":{ "shape":"RoleArn", "documentation":"

The ARN identifier of an AWS user or role that is allowed to call the `GetProgrammaticAccessCredentials` API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" }, "clientToken":{ "shape":"ClientToken", "documentation":"

A token that ensures idempotency. This token expires in 10 minutes.

", "idempotencyToken":true } } }, "UpdateUserResponse":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier of the updated user.

" } } }, "User":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user.

" }, "status":{ "shape":"UserStatus", "documentation":"

The current status of the user.

- `CREATING` – The user creation is in progress.

- `ENABLED` – The user is created and is currently active.

- `DISABLED` – The user is currently inactive.

" }, "firstName":{ "shape":"FirstName", "documentation":"

The first name of the user.

" }, "lastName":{ "shape":"LastName", "documentation":"

The last name of the user.

" }, "emailAddress":{ "shape":"Email", "documentation":"

The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

" }, "type":{ "shape":"UserType", "documentation":"

Indicates the type of user.

- `SUPER_USER` – A user with permission to all the functionality and data in FinSpace.

- `APP_USER` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

" }, "apiAccess":{ "shape":"ApiAccess", "documentation":"

Indicates whether the user can use the `GetProgrammaticAccessCredentials` API to obtain credentials that can then be used to access other FinSpace Data API operations.

- `ENABLED` – The user has permissions to use the APIs.

- `DISABLED` – The user does not have permissions to use any APIs.

" }, "apiAccessPrincipalArn":{ "shape":"RoleArn", "documentation":"

The ARN identifier of an AWS user or role that is allowed to call the `GetProgrammaticAccessCredentials` API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

" }, "createTime":{ "shape":"TimestampEpoch", "documentation":"

The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds.

" }, "lastEnabledTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time the user was activated. The value is determined as epoch time in milliseconds.

" }, "lastDisabledTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.

" }, "lastModifiedTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time the user was updated. The value is determined as epoch time in milliseconds.

" }, "lastLoginTime":{ "shape":"TimestampEpoch", "documentation":"

Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.

" } }, "documentation":"

The details of the user.

" }, "UserByPermissionGroup":{ "type":"structure", "members":{ "userId":{ "shape":"UserId", "documentation":"

The unique identifier for the user.

" }, "status":{ "shape":"UserStatus", "documentation":"

The current status of the user.

- `CREATING` – The user creation is in progress.

- `ENABLED` – The user is created and is currently active.

- `DISABLED` – The user is currently inactive.

" }, "firstName":{ "shape":"FirstName", "documentation":"

The first name of the user.

" }, "lastName":{ "shape":"LastName", "documentation":"

The last name of the user.

" }, "emailAddress":{ "shape":"Email", "documentation":"

The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.

" }, "type":{ "shape":"UserType", "documentation":"

Indicates the type of user.

- `SUPER_USER` – A user with permission to all the functionality and data in FinSpace.

- `APP_USER` – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.

" }, "apiAccess":{ "shape":"ApiAccess", "documentation":"

Indicates whether the user can access FinSpace API operations.

- `ENABLED` – The user has permissions to use the API operations.

- `DISABLED` – The user does not have permissions to use any API operations.

" }, "apiAccessPrincipalArn":{ "shape":"RoleArn", "documentation":"

The IAM ARN identifier that is attached to FinSpace API calls.

" }, "membershipStatus":{ "shape":"PermissionGroupMembershipStatus", "documentation":"

Indicates the status of the user within a permission group.

- `ADDITION_IN_PROGRESS` – The user is currently being added to the permission group.

- `ADDITION_SUCCESS` – The user is successfully added to the permission group.

- `REMOVAL_IN_PROGRESS` – The user is currently being removed from the permission group.

" } }, "documentation":"

The structure of a user associated with a permission group.

" }, "UserByPermissionGroupList":{ "type":"list", "member":{"shape":"UserByPermissionGroup"} }, "UserId":{ "type":"string", "max":26, "min":1, "pattern":".*\\S.*" }, "UserList":{ "type":"list", "member":{"shape":"User"} }, "UserStatus":{ "type":"string", "enum":[ "CREATING", "ENABLED", "DISABLED" ] }, "UserType":{ "type":"string", "enum":[ "SUPER_USER", "APP_USER" ] }, "ValidationException":{ "type":"structure", "members":{ "message":{"shape":"errorMessage"}, "reason":{"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.

" }