The FinSpace APIs let you take actions inside the FinSpace.
', 'operations' => [ 'AssociateUserToPermissionGroup' => 'Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
', 'CreateChangeset' => 'Creates a new Changeset in a FinSpace Dataset.
', 'CreateDataView' => 'Creates a Dataview for a Dataset.
', 'CreateDataset' => 'Creates a new FinSpace Dataset.
', 'CreatePermissionGroup' => 'Creates a group of permissions for various actions that a user can perform in FinSpace.
', 'CreateUser' => 'Creates a new user in FinSpace.
', 'DeleteDataset' => 'Deletes a FinSpace Dataset.
', 'DeletePermissionGroup' => 'Deletes a permission group. This action is irreversible.
', 'DisableUser' => 'Denies access to the FinSpace web application and API for the specified user.
', 'DisassociateUserFromPermissionGroup' => 'Removes a user account from a permission group.
', 'EnableUser' => 'Allows the specified user to access the FinSpace web application and API.
', 'GetChangeset' => 'Get information about a Changeset.
', 'GetDataView' => 'Gets information about a Dataview.
', 'GetDataset' => 'Returns information about a Dataset.
', 'GetExternalDataViewAccessDetails' => '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.
Retrieves the details of a specific permission group.
', 'GetProgrammaticAccessCredentials' => 'Request programmatic credentials to use with FinSpace SDK.
', 'GetUser' => 'Retrieves details for a specific user.
', 'GetWorkingLocation' => 'A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.
', 'ListChangesets' => 'Lists the FinSpace Changesets for a Dataset.
', 'ListDataViews' => 'Lists all available Dataviews for a Dataset.
', 'ListDatasets' => 'Lists all of the active Datasets that a user has access to.
', 'ListPermissionGroups' => 'Lists all available permission groups in FinSpace.
', 'ListPermissionGroupsByUser' => 'Lists all the permission groups that are associated with a specific user account.
', 'ListUsers' => 'Lists all available user accounts in FinSpace.
', 'ListUsersByPermissionGroup' => 'Lists details of all the users in a specific permission group.
', 'ResetUserPassword' => '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.
', 'UpdateChangeset' => 'Updates a FinSpace Changeset.
', 'UpdateDataset' => 'Updates a FinSpace Dataset.
', 'UpdatePermissionGroup' => 'Modifies the details of a permission group. You cannot modify a permissionGroupID.
Modifies the details of the specified user account. You cannot update the userId for a user.
You do not have sufficient access to perform this action.
', 'refs' => [], ], 'AccessKeyId' => [ 'base' => NULL, 'refs' => [ 'AwsCredentials$accessKeyId' => 'The unique identifier for the security credentials.
', ], ], 'AliasString' => [ 'base' => NULL, 'refs' => [ 'CreateDatasetRequest$alias' => 'The unique resource identifier for a Dataset.
', 'Dataset$alias' => 'The unique resource identifier for a Dataset.
', 'GetDatasetResponse$alias' => 'The unique resource identifier for a Dataset.
', 'UpdateDatasetRequest$alias' => 'The unique resource identifier for a Dataset.
', ], ], 'ApiAccess' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$ApiAccess' => '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.
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.
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.
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.
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.
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.
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.
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.
The credentials required to access the external Dataview from the S3 location.
', 'refs' => [ 'GetExternalDataViewAccessDetailsResponse$credentials' => 'The credentials required to access the external Dataview from the S3 location.
', ], ], 'Boolean' => [ 'base' => 'Common Boolean data type', 'refs' => [ 'CreateDataViewRequest$autoUpdate' => 'Flag to indicate Dataview should be updated automatically.
', 'DataViewSummary$autoUpdate' => 'The flag to indicate Dataview should be updated automatically.
', 'GetDataViewResponse$autoUpdate' => 'Flag to indicate Dataview should be updated automatically.
', ], ], 'ChangeType' => [ 'base' => 'Indicates how the given change will be applied to the dataset.', 'refs' => [ 'ChangesetSummary$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.
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.
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.
The ARN identifier of the Changeset.
', 'GetChangesetResponse$changesetArn' => 'The ARN identifier of the Changeset.
', ], ], 'ChangesetErrorInfo' => [ 'base' => 'The structure with error messages.
', 'refs' => [ 'ChangesetSummary$errorInfo' => 'The structure with error messages.
', 'GetChangesetResponse$errorInfo' => 'The structure with error messages.
', ], ], 'ChangesetId' => [ 'base' => 'ID used to identify a Changeset', 'refs' => [ 'ChangesetSummary$changesetId' => 'The unique identifier for a Changeset.
', 'ChangesetSummary$updatesChangesetId' => 'The unique identifier of the Changeset that is updated.
', 'ChangesetSummary$updatedByChangesetId' => 'The unique identifier of the updated Changeset.
', 'CreateChangesetResponse$changesetId' => 'The unique identifier of the Changeset that is created.
', 'GetChangesetRequest$changesetId' => 'The unique identifier of the Changeset for which to get data.
', 'GetChangesetResponse$changesetId' => 'The unique identifier for a Changeset.
', 'GetChangesetResponse$updatesChangesetId' => 'The unique identifier of the Changeset that is being updated.
', 'GetChangesetResponse$updatedByChangesetId' => 'The unique identifier of the updated Changeset.
', 'UpdateChangesetRequest$changesetId' => 'The unique identifier for the Changeset to update.
', 'UpdateChangesetResponse$changesetId' => 'The unique identifier for the Changeset to update.
', ], ], 'ChangesetList' => [ 'base' => 'List of Changeset Summaries', 'refs' => [ 'ListChangesetsResponse$changesets' => 'List of Changesets found.
', ], ], 'ChangesetSummary' => [ 'base' => 'A Changeset is unit of data in a Dataset.
', 'refs' => [ 'ChangesetList$member' => NULL, ], ], 'ClientToken' => [ 'base' => 'Idempotence Token for API operations', 'refs' => [ 'AssociateUserToPermissionGroupRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'CreateChangesetRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'CreateDataViewRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'CreateDatasetRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'CreatePermissionGroupRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'CreateUserRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'DeleteDatasetRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'DeletePermissionGroupRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'DisableUserRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'DisassociateUserFromPermissionGroupRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'EnableUserRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'ResetUserPasswordRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'UpdateChangesetRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'UpdateDatasetRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'UpdatePermissionGroupRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', 'UpdateUserRequest$clientToken' => 'A token that ensures idempotency. This token expires in 10 minutes.
', ], ], 'ColumnDataType' => [ 'base' => 'Data type of a column.', 'refs' => [ 'ColumnDefinition$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.
The definition of a column in a tabular Dataset.
', 'refs' => [ 'ColumnList$member' => NULL, ], ], 'ColumnDescription' => [ 'base' => 'Column Description', 'refs' => [ 'ColumnDefinition$columnDescription' => 'Description for a column.
', ], ], 'ColumnList' => [ 'base' => 'List of Column Definitions', 'refs' => [ 'SchemaDefinition$columns' => 'List of column definitions.
', ], ], 'ColumnName' => [ 'base' => 'Column Name', 'refs' => [ 'ColumnDefinition$columnName' => 'The name of a column.
', 'ColumnNameList$member' => NULL, ], ], 'ColumnNameList' => [ 'base' => 'List of Column Names', 'refs' => [ 'SchemaDefinition$primaryKeyColumns' => 'List of column names used for primary key.
', ], ], 'ConflictException' => [ 'base' => 'The request conflicts with an existing resource.
', 'refs' => [], ], 'CreateChangesetRequest' => [ 'base' => 'The request for a CreateChangeset operation.', 'refs' => [], ], 'CreateChangesetResponse' => [ 'base' => 'The response from a CreateChangeset operation.', 'refs' => [], ], 'CreateDataViewRequest' => [ 'base' => 'Request for creating a data view.', 'refs' => [], ], 'CreateDataViewResponse' => [ 'base' => 'Response for creating a data view.', 'refs' => [], ], 'CreateDatasetRequest' => [ 'base' => 'The request for a CreateDataset operation', 'refs' => [], ], 'CreateDatasetResponse' => [ 'base' => 'The response from a CreateDataset operation', 'refs' => [], ], 'CreatePermissionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreatePermissionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'CreateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'Credentials' => [ 'base' => 'Short term API credentials.
', 'refs' => [ 'GetProgrammaticAccessCredentialsResponse$credentials' => 'Returns the programmatic credentials.
', ], ], 'DataViewArn' => [ 'base' => 'Arn of a DataView', 'refs' => [ 'DataViewSummary$dataViewArn' => 'The ARN identifier of the Dataview.
', 'GetDataViewResponse$dataViewArn' => 'The ARN identifier of the Dataview.
', ], ], 'DataViewDestinationType' => [ 'base' => 'DataView Destination Type', 'refs' => [ 'DataViewDestinationTypeParams$destinationType' => 'Destination type for a Dataview.
GLUE_TABLE – Glue table destination type.
S3 – S3 destination type.
Structure for the Dataview destination type parameters.
', 'refs' => [ 'CreateDataViewRequest$destinationTypeParams' => 'Options that define the destination type for the Dataview.
', 'DataViewSummary$destinationTypeProperties' => 'Information about the Dataview destination.
', 'GetDataViewResponse$destinationTypeParams' => 'Options that define the destination type for the Dataview.
', ], ], 'DataViewErrorInfo' => [ 'base' => 'The structure with error messages.
', 'refs' => [ 'DataViewSummary$errorInfo' => 'The structure with error messages.
', 'GetDataViewResponse$errorInfo' => 'Information about an error that occurred for the Dataview.
', ], ], 'DataViewId' => [ 'base' => 'DataView ID', 'refs' => [ 'CreateDataViewResponse$dataViewId' => 'The unique identifier for the created Dataview.
', 'DataViewSummary$dataViewId' => 'The unique identifier for the Dataview.
', 'GetDataViewRequest$dataViewId' => 'The unique identifier for the Dataview.
', 'GetDataViewResponse$dataViewId' => 'The unique identifier for the Dataview.
', 'GetExternalDataViewAccessDetailsRequest$dataViewId' => 'The unique identifier for the Dataview that you want to access.
', ], ], 'DataViewList' => [ 'base' => 'List of Data Views', 'refs' => [ 'ListDataViewsResponse$dataViews' => 'A list of Dataviews.
', ], ], 'DataViewStatus' => [ 'base' => 'Status of a DataView', 'refs' => [ 'DataViewSummary$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.
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.
Structure for the summary of a Dataview.
', 'refs' => [ 'DataViewList$member' => NULL, ], ], 'Dataset' => [ 'base' => 'The structure for a Dataset.
', 'refs' => [ 'DatasetList$member' => NULL, ], ], 'DatasetArn' => [ 'base' => 'Arn of a Dataset', 'refs' => [ 'Dataset$datasetArn' => 'The ARN identifier of the Dataset.
', 'GetDatasetResponse$datasetArn' => 'The ARN identifier of the Dataset.
', ], ], 'DatasetDescription' => [ 'base' => 'Description of a dataset', 'refs' => [ 'CreateDatasetRequest$datasetDescription' => 'Description of a Dataset.
', 'Dataset$datasetDescription' => 'Description for a Dataset.
', 'GetDatasetResponse$datasetDescription' => 'A description of the Dataset.
', 'UpdateDatasetRequest$datasetDescription' => 'A description for the Dataset.
', ], ], 'DatasetId' => [ 'base' => 'ID for a given Dataset', 'refs' => [ 'ChangesetSummary$datasetId' => 'The unique identifier for the FinSpace Dataset in which the Changeset is created.
', 'CreateChangesetRequest$datasetId' => 'The unique identifier for the FinSpace Dataset where the Changeset will be created.
', 'CreateChangesetResponse$datasetId' => 'The unique identifier for the FinSpace Dataset where the Changeset is created.
', 'CreateDataViewRequest$datasetId' => 'The unique Dataset identifier that is used to create a Dataview.
', 'CreateDataViewResponse$datasetId' => 'The unique identifier of the Dataset used for the Dataview.
', 'CreateDatasetResponse$datasetId' => 'The unique identifier for the created Dataset.
', 'DataViewSummary$datasetId' => 'Th unique identifier for the Dataview Dataset.
', 'Dataset$datasetId' => 'An identifier for a Dataset.
', 'DeleteDatasetRequest$datasetId' => 'The unique identifier of the Dataset to be deleted.
', 'DeleteDatasetResponse$datasetId' => 'The unique identifier for the deleted Dataset.
', 'GetChangesetRequest$datasetId' => 'The unique identifier for the FinSpace Dataset where the Changeset is created.
', 'GetChangesetResponse$datasetId' => 'The unique identifier for the FinSpace Dataset where the Changeset is created.
', 'GetDataViewRequest$datasetId' => 'The unique identifier for the Dataset used in the Dataview.
', 'GetDataViewResponse$datasetId' => 'The unique identifier for the Dataset used in the Dataview.
', 'GetDatasetResponse$datasetId' => 'The unique identifier for a Dataset.
', 'GetExternalDataViewAccessDetailsRequest$datasetId' => 'The unique identifier for the Dataset.
', 'ListChangesetsRequest$datasetId' => 'The unique identifier for the FinSpace Dataset to which the Changeset belongs.
', 'ListDataViewsRequest$datasetId' => 'The unique identifier of the Dataset for which to retrieve Dataviews.
', 'UpdateChangesetRequest$datasetId' => 'The unique identifier for the FinSpace Dataset in which the Changeset is created.
', 'UpdateChangesetResponse$datasetId' => 'The unique identifier for the FinSpace Dataset in which the Changeset is created.
', 'UpdateDatasetRequest$datasetId' => 'The unique identifier for the Dataset to update.
', 'UpdateDatasetResponse$datasetId' => 'The unique identifier for updated Dataset.
', ], ], 'DatasetKind' => [ 'base' => 'Dataset Kind', 'refs' => [ 'CreateDatasetRequest$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.
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.
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.
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.
List of Datasets.
', ], ], 'DatasetOwnerInfo' => [ 'base' => 'A structure for Dataset owner info.
', 'refs' => [ 'CreateDatasetRequest$ownerInfo' => 'Contact information for a Dataset owner.
', 'Dataset$ownerInfo' => 'Contact information for a Dataset owner.
', ], ], 'DatasetStatus' => [ 'base' => 'Status of the dataset process returned from scheduler service.', 'refs' => [ 'GetDatasetResponse$status' => '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.
Display title for a FinSpace Dataset.
', 'Dataset$datasetTitle' => 'Display title for a Dataset.
', 'GetDatasetResponse$datasetTitle' => 'Display title for a Dataset.
', 'UpdateDatasetRequest$datasetTitle' => 'A display title for the Dataset.
', ], ], 'DeleteDatasetRequest' => [ 'base' => 'The request for a DeleteDataset operation.', 'refs' => [], ], 'DeleteDatasetResponse' => [ 'base' => 'The response from an DeleteDataset operation', 'refs' => [], ], 'DeletePermissionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DeletePermissionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisableUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisableUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateUserFromPermissionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'DisassociateUserFromPermissionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'Email' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$emailAddress' => '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.
', 'DatasetOwnerInfo$email' => 'Email address for the Dataset owner.
', 'GetUserResponse$emailAddress' => 'The email address that is associated with the user.
', 'User$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.
', 'UserByPermissionGroup$emailAddress' => '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.
', ], ], 'EnableUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'EnableUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'ErrorCategory' => [ 'base' => 'Changeset Error Category', 'refs' => [ 'ChangesetErrorInfo$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.
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.
The text of the error message.
', 'DataViewErrorInfo$errorMessage' => 'The text of the error message.
', ], ], 'ExportFileFormat' => [ 'base' => 'Data View Export File Format', 'refs' => [ 'DataViewDestinationTypeParams$s3DestinationExportFileFormat' => 'Dataview export file format.
PARQUET – Parquet export file format.
DELIMITED_TEXT – Delimited text export file format.
The first name of the user that you want to register.
', 'GetUserResponse$firstName' => 'The first name of the user.
', 'UpdateUserRequest$firstName' => 'The first name of the user.
', 'User$firstName' => 'The first name of the user.
', 'UserByPermissionGroup$firstName' => 'The first name of the user.
', ], ], 'FormatParams' => [ 'base' => 'Format Parameters of a Changeset', 'refs' => [ 'ChangesetSummary$formatParams' => 'Options that define the structure of the source file(s).
', 'CreateChangesetRequest$formatParams' => '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.
', 'GetChangesetResponse$formatParams' => 'Structure of the source file(s).
', 'UpdateChangesetRequest$formatParams' => '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.
', ], ], 'GetChangesetRequest' => [ 'base' => 'Request to describe a changeset.', 'refs' => [], ], 'GetChangesetResponse' => [ 'base' => 'The response from a describe changeset operation', 'refs' => [], ], 'GetDataViewRequest' => [ 'base' => 'Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.', 'refs' => [], ], 'GetDataViewResponse' => [ 'base' => 'Response from retrieving a dataview, which includes details on the target database and table name', 'refs' => [], ], 'GetDatasetRequest' => [ 'base' => 'Request for the GetDataset operation.', 'refs' => [], ], 'GetDatasetResponse' => [ 'base' => 'Response for the GetDataset operation', 'refs' => [], ], 'GetExternalDataViewAccessDetailsRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetExternalDataViewAccessDetailsResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetPermissionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetPermissionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetProgrammaticAccessCredentialsRequest' => [ 'base' => 'Request for GetProgrammaticAccessCredentials operation', 'refs' => [], ], 'GetProgrammaticAccessCredentialsResponse' => [ 'base' => 'Response for GetProgrammaticAccessCredentials operation', 'refs' => [], ], 'GetUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkingLocationRequest' => [ 'base' => NULL, 'refs' => [], ], 'GetWorkingLocationResponse' => [ 'base' => NULL, 'refs' => [], ], 'IdType' => [ 'base' => NULL, 'refs' => [ 'GetProgrammaticAccessCredentialsRequest$environmentId' => 'The FinSpace environment identifier.
', ], ], 'IngestionStatus' => [ 'base' => 'Status of the ingestion process returned from scheduler service.', 'refs' => [ 'ChangesetSummary$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.
The status of Changeset creation operation.
', ], ], 'InternalServerException' => [ 'base' => 'The request processing has failed because of an unknown error, exception or failure.
', 'refs' => [], ], 'LastName' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$lastName' => 'The last name of the user that you want to register.
', 'GetUserResponse$lastName' => 'The last name of the user.
', 'UpdateUserRequest$lastName' => 'The last name of the user.
', 'User$lastName' => 'The last name of the user.
', 'UserByPermissionGroup$lastName' => 'The last name of the user.
', ], ], 'LimitExceededException' => [ 'base' => 'A limit has exceeded.
', 'refs' => [], ], 'ListChangesetsRequest' => [ 'base' => 'Request to ListChangesetsRequest. It exposes minimal query filters.', 'refs' => [], ], 'ListChangesetsResponse' => [ 'base' => 'Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.', 'refs' => [], ], 'ListDataViewsRequest' => [ 'base' => 'Request for a list data views.', 'refs' => [], ], 'ListDataViewsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDatasetsRequest' => [ 'base' => 'Request for the ListDatasets operation.', 'refs' => [], ], 'ListDatasetsResponse' => [ 'base' => 'Response for the ListDatasets operation', 'refs' => [], ], 'ListPermissionGroupsByUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPermissionGroupsByUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListPermissionGroupsRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListPermissionGroupsResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersByPermissionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersByPermissionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersRequest' => [ 'base' => NULL, 'refs' => [], ], 'ListUsersResponse' => [ 'base' => NULL, 'refs' => [], ], 'OwnerName' => [ 'base' => '1 - 250 character String', 'refs' => [ 'DatasetOwnerInfo$name' => 'The name of the Dataset owner.
', ], ], 'PaginationToken' => [ 'base' => NULL, 'refs' => [ 'ListChangesetsRequest$nextToken' => 'A token that indicates where a results page should begin.
', 'ListChangesetsResponse$nextToken' => 'A token that indicates where a results page should begin.
', 'ListDataViewsRequest$nextToken' => 'A token that indicates where a results page should begin.
', 'ListDataViewsResponse$nextToken' => 'A token that indicates where a results page should begin.
', 'ListDatasetsRequest$nextToken' => 'A token that indicates where a results page should begin.
', 'ListDatasetsResponse$nextToken' => 'A token that indicates where a results page should begin.
', 'ListPermissionGroupsByUserRequest$nextToken' => 'A token that indicates where a results page should begin.
', 'ListPermissionGroupsByUserResponse$nextToken' => 'A token that indicates where a results page should begin.
', 'ListPermissionGroupsRequest$nextToken' => 'A token that indicates where a results page should begin.
', 'ListPermissionGroupsResponse$nextToken' => 'A token that indicates where a results page should begin.
', 'ListUsersByPermissionGroupRequest$nextToken' => 'A token that indicates where a results page should begin.
', 'ListUsersByPermissionGroupResponse$nextToken' => 'A token that indicates where a results page should begin.
', 'ListUsersRequest$nextToken' => 'A token that indicates where a results page should begin.
', 'ListUsersResponse$nextToken' => 'A token that indicates where a results page should begin.
', ], ], 'PartitionColumnList' => [ 'base' => 'DataView Partition Column List', 'refs' => [ 'CreateDataViewRequest$partitionColumns' => 'Ordered set of column names used to partition data.
', 'DataViewSummary$partitionColumns' => 'Ordered set of column names used to partition data.
', 'GetDataViewResponse$partitionColumns' => 'Ordered set of column names used to partition data.
', ], ], 'Password' => [ 'base' => NULL, 'refs' => [ 'ResetUserPasswordResponse$temporaryPassword' => 'A randomly generated temporary password for the requested user account. This password expires in 7 days.
', ], ], 'PermissionGroup' => [ 'base' => 'The structure for a permission group.
', 'refs' => [ 'GetPermissionGroupResponse$permissionGroup' => NULL, 'PermissionGroupList$member' => NULL, ], ], 'PermissionGroupByUser' => [ 'base' => 'The structure of a permission group associated with a user account.
', 'refs' => [ 'PermissionGroupByUserList$member' => NULL, ], ], 'PermissionGroupByUserList' => [ 'base' => NULL, 'refs' => [ 'ListPermissionGroupsByUserResponse$permissionGroups' => 'A list of returned permission groups.
', ], ], 'PermissionGroupDescription' => [ 'base' => NULL, 'refs' => [ 'CreatePermissionGroupRequest$description' => 'A brief description for the permission group.
', 'PermissionGroup$description' => 'A brief description for the permission group.
', 'UpdatePermissionGroupRequest$description' => 'A brief description for the permission group.
', ], ], 'PermissionGroupId' => [ 'base' => NULL, 'refs' => [ 'AssociateUserToPermissionGroupRequest$permissionGroupId' => 'The unique identifier for the permission group.
', 'CreatePermissionGroupResponse$permissionGroupId' => 'The unique identifier for the permission group.
', 'DeletePermissionGroupRequest$permissionGroupId' => 'The unique identifier for the permission group that you want to delete.
', 'DeletePermissionGroupResponse$permissionGroupId' => 'The unique identifier for the deleted permission group.
', 'DisassociateUserFromPermissionGroupRequest$permissionGroupId' => 'The unique identifier for the permission group.
', 'GetPermissionGroupRequest$permissionGroupId' => 'The unique identifier for the permission group.
', 'ListUsersByPermissionGroupRequest$permissionGroupId' => 'The unique identifier for the permission group.
', 'PermissionGroup$permissionGroupId' => 'The unique identifier for the permission group.
', 'PermissionGroupByUser$permissionGroupId' => 'The unique identifier for the permission group.
', 'PermissionGroupParams$permissionGroupId' => 'The unique identifier for the PermissionGroup.
The unique identifier for the permission group to update.
', 'UpdatePermissionGroupResponse$permissionGroupId' => 'The unique identifier for the updated permission group.
', ], ], 'PermissionGroupList' => [ 'base' => NULL, 'refs' => [ 'ListPermissionGroupsResponse$permissionGroups' => 'A list of all the permission groups.
', ], ], 'PermissionGroupMembershipStatus' => [ 'base' => NULL, 'refs' => [ 'PermissionGroup$membershipStatus' => 'Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
ADDITION_SUCCESS – The user account is successfully added to the permission group.
REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
ADDITION_SUCCESS – The user account is successfully added to the permission group.
REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS – The user account is currently being added to the permission group.
ADDITION_SUCCESS – The user account is successfully added to the permission group.
REMOVAL_IN_PROGRESS – The user is currently being removed from the permission group.
The name of the permission group.
', 'PermissionGroup$name' => 'The name of the permission group.
', 'PermissionGroupByUser$name' => 'The name of the permission group.
', 'UpdatePermissionGroupRequest$name' => 'The name of the permission group.
', ], ], 'PermissionGroupParams' => [ 'base' => '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"} ] }
Permission group parameters for Dataset permissions.
', ], ], 'PhoneNumber' => [ 'base' => 'PhoneNumber of Dataset Owner', 'refs' => [ 'DatasetOwnerInfo$phoneNumber' => 'Phone number for the Dataset owner.
', ], ], 'ResetUserPasswordRequest' => [ 'base' => NULL, 'refs' => [], ], 'ResetUserPasswordResponse' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => 'One or more resources can\'t be found.
', 'refs' => [], ], 'ResourcePermission' => [ 'base' => '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.
', 'refs' => [ 'ResourcePermissionsList$member' => NULL, ], ], 'ResourcePermissionsList' => [ 'base' => 'List of Resource Permissions', 'refs' => [ 'PermissionGroupParams$datasetPermissions' => 'List of resource permissions.
', ], ], 'ResultLimit' => [ 'base' => NULL, 'refs' => [ 'ListChangesetsRequest$maxResults' => 'The maximum number of results per page.
', 'ListDataViewsRequest$maxResults' => 'The maximum number of results per page.
', 'ListDatasetsRequest$maxResults' => 'The maximum number of results per page.
', 'ListPermissionGroupsByUserRequest$maxResults' => 'The maximum number of results per page.
', 'ListPermissionGroupsRequest$maxResults' => 'The maximum number of results per page.
', 'ListUsersByPermissionGroupRequest$maxResults' => 'The maximum number of results per page.
', 'ListUsersRequest$maxResults' => 'The maximum number of results per page.
', ], ], 'RoleArn' => [ 'base' => NULL, 'refs' => [ 'CreateUserRequest$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.
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.
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.
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.
The IAM ARN identifier that is attached to FinSpace API calls.
', ], ], 'S3BucketName' => [ 'base' => NULL, 'refs' => [ 'S3Location$bucket' => 'The name of the S3 bucket.
', ], ], 'S3DestinationFormatOptions' => [ 'base' => NULL, 'refs' => [ 'DataViewDestinationTypeParams$s3DestinationExportFileFormatOptions' => 'Format Options for S3 Destination type.
Here is an example of how you could specify the s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }
The path of the folder, within the S3 bucket that contains the Dataset.
', ], ], 'S3Location' => [ 'base' => 'The location of an external Dataview in an S3 bucket.
', 'refs' => [ 'GetExternalDataViewAccessDetailsResponse$s3Location' => 'The location where the external Dataview is stored.
', ], ], 'SchemaDefinition' => [ 'base' => 'Definition for a schema on a tabular Dataset.
', 'refs' => [ 'SchemaUnion$tabularSchemaConfig' => 'The configuration for a schema on a tabular Dataset.
', ], ], 'SchemaUnion' => [ 'base' => 'A union of schema types.
', 'refs' => [ 'CreateDatasetRequest$schemaDefinition' => 'Definition for a schema on a tabular Dataset.
', 'Dataset$schemaDefinition' => 'Definition for a schema on a tabular Dataset.
', 'GetDatasetResponse$schemaDefinition' => 'Definition for a schema on a tabular Dataset.
', 'UpdateDatasetRequest$schemaDefinition' => 'Definition for a schema on a tabular Dataset.
', ], ], 'SecretAccessKey' => [ 'base' => NULL, 'refs' => [ 'AwsCredentials$secretAccessKey' => 'The secret access key that can be used to sign requests.
', ], ], 'SessionDuration' => [ 'base' => NULL, 'refs' => [ 'GetProgrammaticAccessCredentialsRequest$durationInMinutes' => 'The time duration in which the credentials remain valid.
', 'GetProgrammaticAccessCredentialsResponse$durationInMinutes' => 'Returns the duration in which the credentials will remain valid.
', ], ], 'SessionToken' => [ 'base' => NULL, 'refs' => [ 'AwsCredentials$sessionToken' => 'The token that users must pass to use the credentials.
', ], ], 'SortColumnList' => [ 'base' => 'DataView Sort Column List', 'refs' => [ 'CreateDataViewRequest$sortColumns' => 'Columns to be used for sorting the data.
', 'DataViewSummary$sortColumns' => 'Columns to be used for sorting the data.
', 'GetDataViewResponse$sortColumns' => 'Columns to be used for sorting the data.
', ], ], 'SourceParams' => [ 'base' => 'Source Parameters of a Changeset', 'refs' => [ 'ChangesetSummary$sourceParams' => 'Options that define the location of the data being ingested.
', 'CreateChangesetRequest$sourceParams' => '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.
', 'GetChangesetResponse$sourceParams' => 'Options that define the location of the data being ingested.
', 'UpdateChangesetRequest$sourceParams' => '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.
', ], ], 'StatusCode' => [ 'base' => NULL, 'refs' => [ 'AssociateUserToPermissionGroupResponse$statusCode' => 'The returned status code of the response.
', 'DisassociateUserFromPermissionGroupResponse$statusCode' => 'The returned status code of the response.
', ], ], 'StringMapKey' => [ 'base' => NULL, 'refs' => [ 'FormatParams$key' => NULL, 'S3DestinationFormatOptions$key' => NULL, 'SourceParams$key' => NULL, ], ], 'StringMapValue' => [ 'base' => NULL, 'refs' => [ 'FormatParams$value' => NULL, 'S3DestinationFormatOptions$value' => NULL, 'SourceParams$value' => NULL, ], ], 'StringValueLength1to250' => [ 'base' => '1 - 250 character String', 'refs' => [ 'ResourcePermission$permission' => 'Permission for a resource.
', ], ], 'StringValueLength1to255' => [ 'base' => '1 - 255 character String', 'refs' => [ 'GetDatasetRequest$datasetId' => 'The unique identifier for a Dataset.
', 'PartitionColumnList$member' => NULL, 'SortColumnList$member' => NULL, ], ], 'ThrottlingException' => [ 'base' => 'The request was denied due to request throttling.
', 'refs' => [], ], 'TimestampEpoch' => [ 'base' => 'Milliseconds since UTC epoch', 'refs' => [ 'AwsCredentials$expiration' => 'The Epoch time when the current credentials expire.
', 'ChangesetSummary$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$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.
', 'ChangesetSummary$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.
', 'CreateDataViewRequest$asOfTimestamp' => '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.
', 'DataViewSummary$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.
', 'DataViewSummary$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.
', 'DataViewSummary$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.
', 'Dataset$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.
', 'Dataset$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.
', 'GetChangesetResponse$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.
', 'GetChangesetResponse$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.
', 'GetChangesetResponse$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.
', 'GetDataViewResponse$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.
', 'GetDataViewResponse$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.
', 'GetDataViewResponse$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.
', 'GetDatasetResponse$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.
', 'GetDatasetResponse$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.
', 'GetUserResponse$createTime' => 'The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
', 'GetUserResponse$lastEnabledTime' => 'Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
', 'GetUserResponse$lastDisabledTime' => 'Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
', 'GetUserResponse$lastModifiedTime' => 'Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
', 'GetUserResponse$lastLoginTime' => 'Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
', 'PermissionGroup$createTime' => 'The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
', 'PermissionGroup$lastModifiedTime' => 'Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
', 'User$createTime' => 'The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
', 'User$lastEnabledTime' => 'Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
', 'User$lastDisabledTime' => 'Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
', 'User$lastModifiedTime' => 'Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
', 'User$lastLoginTime' => 'Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
', ], ], 'UpdateChangesetRequest' => [ 'base' => 'Request to update an existing changeset.', 'refs' => [], ], 'UpdateChangesetResponse' => [ 'base' => 'The response from a update changeset operation.', 'refs' => [], ], 'UpdateDatasetRequest' => [ 'base' => 'The request for an UpdateDataset operation', 'refs' => [], ], 'UpdateDatasetResponse' => [ 'base' => 'The response from an UpdateDataset operation', 'refs' => [], ], 'UpdatePermissionGroupRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdatePermissionGroupResponse' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserRequest' => [ 'base' => NULL, 'refs' => [], ], 'UpdateUserResponse' => [ 'base' => NULL, 'refs' => [], ], 'User' => [ 'base' => 'The details of the user account.
', 'refs' => [ 'UserList$member' => NULL, ], ], 'UserByPermissionGroup' => [ 'base' => 'The structure of a user account associated with a permission group.
', 'refs' => [ 'UserByPermissionGroupList$member' => NULL, ], ], 'UserByPermissionGroupList' => [ 'base' => NULL, 'refs' => [ 'ListUsersByPermissionGroupResponse$users' => 'Lists details of all users in a specific permission group.
', ], ], 'UserId' => [ 'base' => NULL, 'refs' => [ 'AssociateUserToPermissionGroupRequest$userId' => 'The unique identifier for the user.
', 'CreateUserResponse$userId' => 'The unique identifier for the user.
', 'DisableUserRequest$userId' => 'The unique identifier for the user account that you want to disable.
', 'DisableUserResponse$userId' => 'The unique identifier for the disabled user account.
', 'DisassociateUserFromPermissionGroupRequest$userId' => 'The unique identifier for the user.
', 'EnableUserRequest$userId' => 'The unique identifier for the user account that you want to enable.
', 'EnableUserResponse$userId' => 'The unique identifier for the enabled user account.
', 'GetUserRequest$userId' => 'The unique identifier of the user to get data for.
', 'GetUserResponse$userId' => 'The unique identifier for the user account that is retrieved.
', 'ListPermissionGroupsByUserRequest$userId' => 'The unique identifier for the user.
', 'ResetUserPasswordRequest$userId' => 'The unique identifier of the user that a temporary password is requested for.
', 'ResetUserPasswordResponse$userId' => 'The unique identifier of the user that a new password is generated for.
', 'UpdateUserRequest$userId' => 'The unique identifier for the user account to update.
', 'UpdateUserResponse$userId' => 'The unique identifier of the updated user account.
', 'User$userId' => 'The unique identifier for the user.
', 'UserByPermissionGroup$userId' => 'The unique identifier for the user.
', ], ], 'UserList' => [ 'base' => NULL, 'refs' => [ 'ListUsersResponse$users' => 'A list of all the user accounts.
', ], ], 'UserStatus' => [ 'base' => NULL, 'refs' => [ 'GetUserResponse$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.
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.
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.
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.
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.
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.
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.
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.
The input fails to satisfy the constraints specified by an AWS service.
', 'refs' => [], ], 'errorMessage' => [ 'base' => NULL, 'refs' => [ 'AccessDeniedException$message' => NULL, 'ConflictException$message' => NULL, 'ConflictException$reason' => NULL, 'InternalServerException$message' => NULL, 'LimitExceededException$message' => NULL, 'ResourceNotFoundException$message' => NULL, 'ResourceNotFoundException$reason' => NULL, 'ValidationException$message' => NULL, 'ValidationException$reason' => NULL, ], ], 'locationType' => [ 'base' => NULL, 'refs' => [ 'GetWorkingLocationRequest$locationType' => '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.
Returns the Amazon S3 URI for the working location.
', 'GetWorkingLocationResponse$s3Path' => 'Returns the Amazon S3 Path for the working location.
', ], ], 'stringValueLength1to255' => [ 'base' => NULL, 'refs' => [ 'Credentials$accessKeyId' => 'The access key identifier.
', ], ], 'stringValueLength1to63' => [ 'base' => NULL, 'refs' => [ 'GetWorkingLocationResponse$s3Bucket' => 'Returns the Amazon S3 bucket name for the working location.
', ], ], 'stringValueMaxLength1000' => [ 'base' => NULL, 'refs' => [ 'Credentials$secretAccessKey' => 'The access key.
', 'Credentials$sessionToken' => 'The session token.
', ], ], ],];