• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for JavaScript
• AWS SDK for PHP V3
• AWS SDK for Python
• AWS SDK for Ruby V3
Data Types
The following data types are supported:
• ChangesetErrorInfo (p. 90)
• ChangesetSummary (p. 91)
• ColumnDefinition (p. 94)
• Credentials (p. 96)
• Dataset (p. 97)
• DatasetOwnerInfo (p. 99)
• DataViewDestinationTypeParams (p. 100)
• DataViewErrorInfo (p. 102)
• DataViewSummary (p. 103)
• PermissionGroup (p. 106)
• PermissionGroupParams (p. 108)
• ResourcePermission (p. 109)
• SchemaDefinition (p. 110)
• SchemaUnion (p. 111)
• User (p. 112)
ChangesetErrorInfo
ChangesetErrorInfo
The structure with error messages.
Contents
Note
In the following list, the required parameters are described first.
errorCategory
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.
Type: String
Valid Values: VALIDATION | SERVICE_QUOTA_EXCEEDED | ACCESS_DENIED |
RESOURCE_NOT_FOUND | THROTTLING | INTERNAL_SERVICE_EXCEPTION | CANCELLED | USER_RECOVERABLE
Required: No errorMessage
The text of the error message.
Type: String
Length Constraints: Maximum length of 1000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ChangesetSummary
ChangesetSummary
A Changeset is unit of data in a Dataset.
Contents
NoteIn the following list, the required parameters are described first.
activeFromTimestamp
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.
Type: Long Required: No activeUntilTimestamp
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.
Type: Long Required: No changesetArn
The ARN identifier of the Changeset.
Type: String Required: No changesetId
The unique identifier for a Changeset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Required: No changeType
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.
Type: String
Valid Values: REPLACE | APPEND | MODIFY Required: No
createTime
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.
ChangesetSummary
Type: Long Required: No datasetId
The unique identifier for the FinSpace Dataset in which the Changeset is created.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Required: No errorInfo
The structure with error messages.
Type: ChangesetErrorInfo (p. 90) object Required: No
formatParams
Options that define the structure of the source file(s).
Type: String to string map
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]*\S[\s\S]*
Value Length Constraints: Maximum length of 1000.
Value Pattern: [\s\S]*\S[\s\S]*
Required: No sourceParams
Options that define the location of the data being ingested.
Type: String to string map
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]*\S[\s\S]*
Value Length Constraints: Maximum length of 1000.
Value Pattern: [\s\S]*\S[\s\S]*
Required: No status
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.
Type: String
ChangesetSummary
Valid Values: PENDING | FAILED | SUCCESS | RUNNING | STOP_REQUESTED Required: No
updatedByChangesetId
The unique identifier of the updated Changeset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Required: No updatesChangesetId
The unique identifier of the Changeset that is updated.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ColumnDefinition
ColumnDefinition
The definition of a column in a tabular Dataset.
Contents
NoteIn the following list, the required parameters are described first.
columnDescription
Description for a column.
Type: String
Length Constraints: Maximum length of 512.
Pattern: [\s\S]*\S[\s\S]*
Required: No columnName
The name of a column.
Type: String
Length Constraints: Maximum length of 126.
Pattern: .*\S.*
Required: No dataType
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.
Type: String
ColumnDefinition
Valid Values: STRING | CHAR | INTEGER | TINYINT | SMALLINT | BIGINT | FLOAT | DOUBLE | DATE | DATETIME | BOOLEAN | BINARY
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Credentials
Credentials
Short term API credentials.
Contents
Note
In the following list, the required parameters are described first.
accessKeyId
The access key identifier.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: No secretAccessKey
The access key.
Type: String
Length Constraints: Maximum length of 1000.
Required: No sessionToken
The session token.
Type: String
Length Constraints: Maximum length of 1000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
Dataset
Dataset
The structure for a Dataset.
Contents
NoteIn the following list, the required parameters are described first.
alias
The unique resource identifier for a Dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: ^alias\/\S+
Required: No createTime
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.
Type: Long Required: No datasetArn
The ARN identifier of the Dataset.
Type: String Required: No datasetDescription
Description for a Dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1000.
Pattern: [\s\S]*\S[\s\S]*
Required: No datasetId
An identifier for a Dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Required: No datasetTitle
Display title for a Dataset.
Dataset
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: .*\S.*
Required: No kind
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.
Type: String
Valid Values: TABULAR | NON_TABULAR Required: No
lastModifiedTime
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.
Type: Long Required: No ownerInfo
Contact information for a Dataset owner.
Type: DatasetOwnerInfo (p. 99) object Required: No
schemaDefinition
Definition for a schema on a tabular Dataset.
Type: SchemaUnion (p. 111) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DatasetOwnerInfo
DatasetOwnerInfo
A structure for Dataset owner info.
Contents
Note
In the following list, the required parameters are described first.
Email address for the Dataset owner.
Type: String
Length Constraints: Minimum length of 4. Maximum length of 320.
Pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}
Required: No name
The name of the Dataset owner.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Pattern: .*\S.*
Required: No phoneNumber
Phone number for the Dataset owner.
Type: String
Length Constraints: Minimum length of 10. Maximum length of 20.
Pattern: ^[\+0-9\#\,\(][\+0-9\-\.\/\(\)\,\#\s]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DataViewDestinationTypeParams
DataViewDestinationTypeParams
Structure for the Dataview destination type parameters.
Contents
Note
In the following list, the required parameters are described first.
destinationType
Destination type for a Dataview.
• GLUE_TABLE – Glue table destination type.
• S3 – S3 destination type.
Type: String Required: Yes
s3DestinationExportFileFormat Data view export file format.
• PARQUET – Parquet export file format.
• DELIMITED_TEXT – Delimited text export file format.
Type: String
Valid Values: PARQUET | DELIMITED_TEXT Required: No
s3DestinationExportFileFormatOptions Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions { "header": "true", "delimiter": ",", "compression": "gzip" }
Type: String to string map
Key Length Constraints: Maximum length of 128.
Key Pattern: [\s\S]*\S[\s\S]*
Value Length Constraints: Maximum length of 1000.
Value Pattern: [\s\S]*\S[\s\S]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
DataViewDestinationTypeParams
• AWS SDK for Ruby V3
DataViewErrorInfo
DataViewErrorInfo
The structure with error messages.
Contents
Note
In the following list, the required parameters are described first.
errorCategory
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.
Type: String
Valid Values: VALIDATION | SERVICE_QUOTA_EXCEEDED | ACCESS_DENIED |
RESOURCE_NOT_FOUND | THROTTLING | INTERNAL_SERVICE_EXCEPTION | CANCELLED | USER_RECOVERABLE
Required: No errorMessage
The text of the error message.
Type: String
Length Constraints: Maximum length of 1000.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
DataViewSummary
DataViewSummary
Structure for the summary of a Dataview.
Contents
NoteIn the following list, the required parameters are described first.
asOfTimestamp
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.
Type: Long Required: No autoUpdate
The flag to indicate Dataview should be updated automatically.
Type: Boolean Required: No createTime
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.
Type: Long Required: No datasetId
Th unique identifier for the Dataview Dataset.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Required: No dataViewArn
The ARN identifier of the Dataview.
Type: String Required: No dataViewId
The unique identifier for the Dataview.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Required: No
DataViewSummary
destinationTypeProperties
Information about the Dataview destination.
Type: DataViewDestinationTypeParams (p. 100) object Required: No
errorInfo
The structure with error messages.
Type: DataViewErrorInfo (p. 102) object Required: No
lastModifiedTime
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.
Type: Long Required: No partitionColumns
Ordered set of column names used to partition data.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [\s\S]*\S[\s\S]*
Required: No sortColumns
Columns to be used for sorting the data.
Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: [\s\S]*\S[\s\S]*
Required: No status
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.
Type: String
DataViewSummary
Valid Values: RUNNING | STARTING | FAILED | CANCELLED | TIMEOUT | SUCCESS | PENDING | FAILED_CLEANUP_FAILED
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PermissionGroup
PermissionGroup
The structure for a permission group.
Contents
NoteIn the following list, the required parameters are described first.
applicationPermissions
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
• 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.
• 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.
Type: Array of strings
Valid Values: CreateDataset | ManageClusters | ManageUsersAndGroups
| ManageAttributeSets | ViewAuditData | AccessNotebooks | GetTemporaryCredentials
Required: No createTime
The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
Type: Long Required: No description
A brief description for the permission group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 4000.
Pattern: .*\S.*
Required: No lastModifiedTime
Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
Type: Long Required: No
PermissionGroup
name
The name of the permission group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern: .*\S.*
Required: No permissionGroupId
The unique identifier for the permission group.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern: .*\S.*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
PermissionGroupParams
PermissionGroupParams
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"} ] }
Contents
NoteIn the following list, the required parameters are described first.
datasetPermissions
List of resource permissions.
Type: Array of ResourcePermission (p. 109) objects Required: No
permissionGroupId
The unique identifier for the PermissionGroup.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 26.
Pattern: .*\S.*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
ResourcePermission
ResourcePermission
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
• CreateSnapshot
• EditDatasetMetadata
• DeleteDataset
For more information on the dataset permissions, see Supported Dataset Permissions in the FinSpace User Guide.
Contents
Note
In the following list, the required parameters are described first.
permission
Permission for a resource.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 250.
Pattern: [\s\S]*\S[\s\S]*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SchemaDefinition
SchemaDefinition
Definition for a schema on a tabular Dataset.
Contents
Note
In the following list, the required parameters are described first.
columns
List of column definitions.
Type: Array of ColumnDefinition (p. 94) objects Required: No
primaryKeyColumns
List of column names used for primary key.
Type: Array of strings
Length Constraints: Maximum length of 126.
Pattern: .*\S.*
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
SchemaUnion
SchemaUnion
A union of schema types.
Contents
Note
In the following list, the required parameters are described first.
tabularSchemaConfig
The configuration for a schema on a tabular Dataset.
Type: SchemaDefinition (p. 110) object Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
• AWS SDK for C++
• AWS SDK for Go
• AWS SDK for Java V2
• AWS SDK for Ruby V3
User
User
The details of the user account.
Contents
NoteIn the following list, the required parameters are described first.
apiAccess
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.
Type: String
Valid Values: ENABLED | DISABLED Required: No
apiAccessPrincipalArn
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.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern: ^arn:aws[a-z\-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@\-_/]+$
Required: No createTime
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
Type: Long Required: No emailAddress
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: String
Length Constraints: Minimum length of 4. Maximum length of 320.
Pattern: [A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,4}
Required: No firstName
The first name of the user.
Type: String
User
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: .*\S.*
Required: No lastDisabledTime
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
Type: Long Required: No lastEnabledTime
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
Type: Long Required: No lastLoginTime
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
Type: Long Required: No lastModifiedTime
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
Type: Long Required: No lastName
The last name of the user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 50.
Pattern: .*\S.*
Required: No status
The current status of the user account.
• CREATING – The user account creation is in progress.
• ENABLED – The user account is created and is currently active.
• DISABLED – The user account is currently inactive.
Type: String
Valid Values: CREATING | ENABLED | DISABLED Required: No