Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.FinSpaceData.Lens

Contents

Operations
Types

Description

Synopsis

Operations

AssociateUserToPermissionGroup

associateUserToPermissionGroup_clientToken :: Lens' AssociateUserToPermissionGroup (Maybe Text) Source #

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

associateUserToPermissionGroup_permissionGroupId :: Lens' AssociateUserToPermissionGroup Text Source #

The unique identifier for the permission group.

associateUserToPermissionGroup_userId :: Lens' AssociateUserToPermissionGroup Text Source #

The unique identifier for the user.

associateUserToPermissionGroupResponse_statusCode :: Lens' AssociateUserToPermissionGroupResponse Int Source #

The returned status code of the response.

CreateChangeset

createChangeset_clientToken :: Lens' CreateChangeset (Maybe Text) Source #

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

createChangeset_datasetId :: Lens' CreateChangeset Text Source #

The unique identifier for the FinSpace Dataset where the Changeset will be created.

createChangeset_changeType :: Lens' CreateChangeset ChangeType Source #

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.

createChangeset_sourceParams :: Lens' CreateChangeset (HashMap Text Text) Source #

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.

createChangeset_formatParams :: Lens' CreateChangeset (HashMap Text Text) Source #

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.

createChangesetResponse_changesetId :: Lens' CreateChangesetResponse (Maybe Text) Source #

The unique identifier of the Changeset that is created.

createChangesetResponse_datasetId :: Lens' CreateChangesetResponse (Maybe Text) Source #

The unique identifier for the FinSpace Dataset where the Changeset is created.

createChangesetResponse_httpStatus :: Lens' CreateChangesetResponse Int Source #

The response's http status code.

CreateDataView

createDataView_asOfTimestamp :: Lens' CreateDataView (Maybe Integer) Source #

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.

createDataView_autoUpdate :: Lens' CreateDataView (Maybe Bool) Source #

Flag to indicate Dataview should be updated automatically.

createDataView_clientToken :: Lens' CreateDataView (Maybe Text) Source #

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

createDataView_partitionColumns :: Lens' CreateDataView (Maybe [Text]) Source #

Ordered set of column names used to partition data.

createDataView_sortColumns :: Lens' CreateDataView (Maybe [Text]) Source #

Columns to be used for sorting the data.

createDataView_datasetId :: Lens' CreateDataView Text Source #

The unique Dataset identifier that is used to create a Dataview.

createDataView_destinationTypeParams :: Lens' CreateDataView DataViewDestinationTypeParams Source #

Options that define the destination type for the Dataview.

createDataViewResponse_dataViewId :: Lens' CreateDataViewResponse (Maybe Text) Source #

The unique identifier for the created Dataview.

createDataViewResponse_datasetId :: Lens' CreateDataViewResponse (Maybe Text) Source #

The unique identifier of the Dataset used for the Dataview.

createDataViewResponse_httpStatus :: Lens' CreateDataViewResponse Int Source #

The response's http status code.

CreateDataset

createDataset_alias :: Lens' CreateDataset (Maybe Text) Source #

The unique resource identifier for a Dataset.

createDataset_clientToken :: Lens' CreateDataset (Maybe Text) Source #

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

createDataset_datasetDescription :: Lens' CreateDataset (Maybe Text) Source #

Description of a Dataset.

createDataset_ownerInfo :: Lens' CreateDataset (Maybe DatasetOwnerInfo) Source #

Contact information for a Dataset owner.

createDataset_schemaDefinition :: Lens' CreateDataset (Maybe SchemaUnion) Source #

Definition for a schema on a tabular Dataset.

createDataset_datasetTitle :: Lens' CreateDataset Text Source #

Display title for a FinSpace Dataset.

createDataset_kind :: Lens' CreateDataset DatasetKind Source #

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.

createDataset_permissionGroupParams :: Lens' CreateDataset PermissionGroupParams Source #

Permission group parameters for Dataset permissions.

createDatasetResponse_datasetId :: Lens' CreateDatasetResponse (Maybe Text) Source #

The unique identifier for the created Dataset.

createDatasetResponse_httpStatus :: Lens' CreateDatasetResponse Int Source #

The response's http status code.

CreatePermissionGroup

createPermissionGroup_clientToken :: Lens' CreatePermissionGroup (Maybe Text) Source #

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

createPermissionGroup_description :: Lens' CreatePermissionGroup (Maybe Text) Source #

A brief description for the permission group.

createPermissionGroup_name :: Lens' CreatePermissionGroup Text Source #

The name of the permission group.

createPermissionGroup_applicationPermissions :: Lens' CreatePermissionGroup [ApplicationPermission] Source #

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.

createPermissionGroupResponse_permissionGroupId :: Lens' CreatePermissionGroupResponse (Maybe Text) Source #

The unique identifier for the permission group.

createPermissionGroupResponse_httpStatus :: Lens' CreatePermissionGroupResponse Int Source #

The response's http status code.

CreateUser

createUser_apiAccess :: Lens' CreateUser (Maybe ApiAccess) Source #

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.

createUser_apiAccessPrincipalArn :: Lens' CreateUser (Maybe Text) Source #

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.

createUser_clientToken :: Lens' CreateUser (Maybe Text) Source #

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

createUser_firstName :: Lens' CreateUser (Maybe Text) Source #

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

createUser_lastName :: Lens' CreateUser (Maybe Text) Source #

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

createUser_emailAddress :: Lens' CreateUser Text Source #

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.

createUser_type :: Lens' CreateUser UserType Source #

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.

createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text) Source #

The unique identifier for the user.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.

DeleteDataset

deleteDataset_clientToken :: Lens' DeleteDataset (Maybe Text) Source #

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

deleteDataset_datasetId :: Lens' DeleteDataset Text Source #

The unique identifier of the Dataset to be deleted.

deleteDatasetResponse_datasetId :: Lens' DeleteDatasetResponse (Maybe Text) Source #

The unique identifier for the deleted Dataset.

deleteDatasetResponse_httpStatus :: Lens' DeleteDatasetResponse Int Source #

The response's http status code.

DeletePermissionGroup

deletePermissionGroup_clientToken :: Lens' DeletePermissionGroup (Maybe Text) Source #

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

deletePermissionGroup_permissionGroupId :: Lens' DeletePermissionGroup Text Source #

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

deletePermissionGroupResponse_permissionGroupId :: Lens' DeletePermissionGroupResponse (Maybe Text) Source #

The unique identifier for the deleted permission group.

deletePermissionGroupResponse_httpStatus :: Lens' DeletePermissionGroupResponse Int Source #

The response's http status code.

DisableUser

disableUser_clientToken :: Lens' DisableUser (Maybe Text) Source #

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

disableUser_userId :: Lens' DisableUser Text Source #

The unique identifier for the user account that you want to disable.

disableUserResponse_userId :: Lens' DisableUserResponse (Maybe Text) Source #

The unique identifier for the disabled user account.

disableUserResponse_httpStatus :: Lens' DisableUserResponse Int Source #

The response's http status code.

DisassociateUserFromPermissionGroup

disassociateUserFromPermissionGroup_clientToken :: Lens' DisassociateUserFromPermissionGroup (Maybe Text) Source #

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

disassociateUserFromPermissionGroup_permissionGroupId :: Lens' DisassociateUserFromPermissionGroup Text Source #

The unique identifier for the permission group.

disassociateUserFromPermissionGroup_userId :: Lens' DisassociateUserFromPermissionGroup Text Source #

The unique identifier for the user.

disassociateUserFromPermissionGroupResponse_statusCode :: Lens' DisassociateUserFromPermissionGroupResponse Int Source #

The returned status code of the response.

EnableUser

enableUser_clientToken :: Lens' EnableUser (Maybe Text) Source #

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

enableUser_userId :: Lens' EnableUser Text Source #

The unique identifier for the user account that you want to enable.

enableUserResponse_userId :: Lens' EnableUserResponse (Maybe Text) Source #

The unique identifier for the enabled user account.

enableUserResponse_httpStatus :: Lens' EnableUserResponse Int Source #

The response's http status code.

GetChangeset

getChangeset_datasetId :: Lens' GetChangeset Text Source #

The unique identifier for the FinSpace Dataset where the Changeset is created.

getChangeset_changesetId :: Lens' GetChangeset Text Source #

The unique identifier of the Changeset for which to get data.

getChangesetResponse_activeFromTimestamp :: Lens' GetChangesetResponse (Maybe Integer) Source #

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.

getChangesetResponse_activeUntilTimestamp :: Lens' GetChangesetResponse (Maybe Integer) Source #

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_changeType :: Lens' GetChangesetResponse (Maybe ChangeType) Source #

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.

getChangesetResponse_changesetArn :: Lens' GetChangesetResponse (Maybe Text) Source #

The ARN identifier of the Changeset.

getChangesetResponse_changesetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier for a Changeset.

getChangesetResponse_createTime :: Lens' GetChangesetResponse (Maybe Integer) Source #

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_datasetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier for the FinSpace Dataset where the Changeset is created.

getChangesetResponse_errorInfo :: Lens' GetChangesetResponse (Maybe ChangesetErrorInfo) Source #

The structure with error messages.

getChangesetResponse_formatParams :: Lens' GetChangesetResponse (Maybe (HashMap Text Text)) Source #

Structure of the source file(s).

getChangesetResponse_sourceParams :: Lens' GetChangesetResponse (Maybe (HashMap Text Text)) Source #

Options that define the location of the data being ingested.

getChangesetResponse_status :: Lens' GetChangesetResponse (Maybe IngestionStatus) Source #

The status of Changeset creation operation.

getChangesetResponse_updatedByChangesetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier of the updated Changeset.

getChangesetResponse_updatesChangesetId :: Lens' GetChangesetResponse (Maybe Text) Source #

The unique identifier of the Changeset that is being updated.

getChangesetResponse_httpStatus :: Lens' GetChangesetResponse Int Source #

The response's http status code.

GetDataView

getDataView_dataViewId :: Lens' GetDataView Text Source #

The unique identifier for the Dataview.

getDataView_datasetId :: Lens' GetDataView Text Source #

The unique identifier for the Dataset used in the Dataview.

getDataViewResponse_asOfTimestamp :: Lens' GetDataViewResponse (Maybe Integer) Source #

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_autoUpdate :: Lens' GetDataViewResponse (Maybe Bool) Source #

Flag to indicate Dataview should be updated automatically.

getDataViewResponse_createTime :: Lens' GetDataViewResponse (Maybe Integer) Source #

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.

getDataViewResponse_dataViewArn :: Lens' GetDataViewResponse (Maybe Text) Source #

The ARN identifier of the Dataview.

getDataViewResponse_dataViewId :: Lens' GetDataViewResponse (Maybe Text) Source #

The unique identifier for the Dataview.

getDataViewResponse_datasetId :: Lens' GetDataViewResponse (Maybe Text) Source #

The unique identifier for the Dataset used in the Dataview.

getDataViewResponse_destinationTypeParams :: Lens' GetDataViewResponse (Maybe DataViewDestinationTypeParams) Source #

Options that define the destination type for the Dataview.

getDataViewResponse_errorInfo :: Lens' GetDataViewResponse (Maybe DataViewErrorInfo) Source #

Information about an error that occurred for the Dataview.

getDataViewResponse_lastModifiedTime :: Lens' GetDataViewResponse (Maybe Integer) Source #

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_partitionColumns :: Lens' GetDataViewResponse (Maybe [Text]) Source #

Ordered set of column names used to partition data.

getDataViewResponse_sortColumns :: Lens' GetDataViewResponse (Maybe [Text]) Source #

Columns to be used for sorting the data.

getDataViewResponse_status :: Lens' GetDataViewResponse (Maybe DataViewStatus) Source #

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.

getDataViewResponse_httpStatus :: Lens' GetDataViewResponse Int Source #

The response's http status code.

GetDataset

getDataset_datasetId :: Lens' GetDataset Text Source #

The unique identifier for a Dataset.

getDatasetResponse_alias :: Lens' GetDatasetResponse (Maybe Text) Source #

The unique resource identifier for a Dataset.

getDatasetResponse_createTime :: Lens' GetDatasetResponse (Maybe Integer) Source #

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_datasetArn :: Lens' GetDatasetResponse (Maybe Text) Source #

The ARN identifier of the Dataset.

getDatasetResponse_datasetDescription :: Lens' GetDatasetResponse (Maybe Text) Source #

A description of the Dataset.

getDatasetResponse_datasetId :: Lens' GetDatasetResponse (Maybe Text) Source #

The unique identifier for a Dataset.

getDatasetResponse_datasetTitle :: Lens' GetDatasetResponse (Maybe Text) Source #

Display title for a Dataset.

getDatasetResponse_kind :: Lens' GetDatasetResponse (Maybe DatasetKind) Source #

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.

getDatasetResponse_lastModifiedTime :: Lens' GetDatasetResponse (Maybe Integer) Source #

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.

getDatasetResponse_schemaDefinition :: Lens' GetDatasetResponse (Maybe SchemaUnion) Source #

Definition for a schema on a tabular Dataset.

getDatasetResponse_status :: Lens' GetDatasetResponse (Maybe DatasetStatus) Source #

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.

getDatasetResponse_httpStatus :: Lens' GetDatasetResponse Int Source #

The response's http status code.

GetExternalDataViewAccessDetails

getExternalDataViewAccessDetails_dataViewId :: Lens' GetExternalDataViewAccessDetails Text Source #

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

getExternalDataViewAccessDetails_datasetId :: Lens' GetExternalDataViewAccessDetails Text Source #

The unique identifier for the Dataset.

getExternalDataViewAccessDetailsResponse_credentials :: Lens' GetExternalDataViewAccessDetailsResponse (Maybe AwsCredentials) Source #

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

getExternalDataViewAccessDetailsResponse_s3Location :: Lens' GetExternalDataViewAccessDetailsResponse (Maybe S3Location) Source #

The location where the external Dataview is stored.

getExternalDataViewAccessDetailsResponse_httpStatus :: Lens' GetExternalDataViewAccessDetailsResponse Int Source #

The response's http status code.

GetPermissionGroup

getPermissionGroup_permissionGroupId :: Lens' GetPermissionGroup Text Source #

The unique identifier for the permission group.

getPermissionGroupResponse_permissionGroup :: Lens' GetPermissionGroupResponse (Maybe PermissionGroup) Source #

Undocumented member.

getPermissionGroupResponse_httpStatus :: Lens' GetPermissionGroupResponse Int Source #

The response's http status code.

GetProgrammaticAccessCredentials

getProgrammaticAccessCredentials_durationInMinutes :: Lens' GetProgrammaticAccessCredentials (Maybe Natural) Source #

The time duration in which the credentials remain valid.

getProgrammaticAccessCredentials_environmentId :: Lens' GetProgrammaticAccessCredentials Text Source #

The FinSpace environment identifier.

getProgrammaticAccessCredentialsResponse_credentials :: Lens' GetProgrammaticAccessCredentialsResponse (Maybe Credentials) Source #

Returns the programmatic credentials.

getProgrammaticAccessCredentialsResponse_durationInMinutes :: Lens' GetProgrammaticAccessCredentialsResponse (Maybe Natural) Source #

Returns the duration in which the credentials will remain valid.

getProgrammaticAccessCredentialsResponse_httpStatus :: Lens' GetProgrammaticAccessCredentialsResponse Int Source #

The response's http status code.

GetUser

getUser_userId :: Lens' GetUser Text Source #

The unique identifier of the user to get data for.

getUserResponse_apiAccess :: Lens' GetUserResponse (Maybe ApiAccess) Source #

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.

getUserResponse_apiAccessPrincipalArn :: Lens' GetUserResponse (Maybe Text) Source #

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.

getUserResponse_createTime :: Lens' GetUserResponse (Maybe Integer) Source #

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

getUserResponse_emailAddress :: Lens' GetUserResponse (Maybe Text) Source #

The email address that is associated with the user.

getUserResponse_firstName :: Lens' GetUserResponse (Maybe Text) Source #

The first name of the user.

getUserResponse_lastDisabledTime :: Lens' GetUserResponse (Maybe Integer) Source #

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

getUserResponse_lastEnabledTime :: Lens' GetUserResponse (Maybe Integer) Source #

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

getUserResponse_lastLoginTime :: Lens' GetUserResponse (Maybe Integer) Source #

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

getUserResponse_lastModifiedTime :: Lens' GetUserResponse (Maybe Integer) Source #

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

getUserResponse_lastName :: Lens' GetUserResponse (Maybe Text) Source #

The last name of the user.

getUserResponse_status :: Lens' GetUserResponse (Maybe UserStatus) Source #

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.

getUserResponse_type :: Lens' GetUserResponse (Maybe UserType) Source #

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.

getUserResponse_userId :: Lens' GetUserResponse (Maybe Text) Source #

The unique identifier for the user account that is retrieved.

getUserResponse_httpStatus :: Lens' GetUserResponse Int Source #

The response's http status code.

GetWorkingLocation

getWorkingLocation_locationType :: Lens' GetWorkingLocation (Maybe LocationType) Source #

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_s3Bucket :: Lens' GetWorkingLocationResponse (Maybe Text) Source #

Returns the Amazon S3 bucket name for the working location.

getWorkingLocationResponse_s3Path :: Lens' GetWorkingLocationResponse (Maybe Text) Source #

Returns the Amazon S3 Path for the working location.

getWorkingLocationResponse_s3Uri :: Lens' GetWorkingLocationResponse (Maybe Text) Source #

Returns the Amazon S3 URI for the working location.

getWorkingLocationResponse_httpStatus :: Lens' GetWorkingLocationResponse Int Source #

The response's http status code.

ListChangesets

listChangesets_maxResults :: Lens' ListChangesets (Maybe Natural) Source #

The maximum number of results per page.

listChangesets_nextToken :: Lens' ListChangesets (Maybe Text) Source #

A token that indicates where a results page should begin.

listChangesets_datasetId :: Lens' ListChangesets Text Source #

The unique identifier for the FinSpace Dataset to which the Changeset belongs.

listChangesetsResponse_changesets :: Lens' ListChangesetsResponse (Maybe [ChangesetSummary]) Source #

List of Changesets found.

listChangesetsResponse_nextToken :: Lens' ListChangesetsResponse (Maybe Text) Source #

A token that indicates where a results page should begin.

listChangesetsResponse_httpStatus :: Lens' ListChangesetsResponse Int Source #

The response's http status code.

ListDataViews

listDataViews_maxResults :: Lens' ListDataViews (Maybe Natural) Source #

The maximum number of results per page.

listDataViews_nextToken :: Lens' ListDataViews (Maybe Text) Source #

A token that indicates where a results page should begin.

listDataViews_datasetId :: Lens' ListDataViews Text Source #

The unique identifier of the Dataset for which to retrieve Dataviews.

listDataViewsResponse_dataViews :: Lens' ListDataViewsResponse (Maybe [DataViewSummary]) Source #

A list of Dataviews.

listDataViewsResponse_nextToken :: Lens' ListDataViewsResponse (Maybe Text) Source #

A token that indicates where a results page should begin.

listDataViewsResponse_httpStatus :: Lens' ListDataViewsResponse Int Source #

The response's http status code.

ListDatasets

listDatasets_maxResults :: Lens' ListDatasets (Maybe Natural) Source #

The maximum number of results per page.

listDatasets_nextToken :: Lens' ListDatasets (Maybe Text) Source #

A token that indicates where a results page should begin.

listDatasetsResponse_datasets :: Lens' ListDatasetsResponse (Maybe [Dataset]) Source #

List of Datasets.

listDatasetsResponse_nextToken :: Lens' ListDatasetsResponse (Maybe Text) Source #

A token that indicates where a results page should begin.

listDatasetsResponse_httpStatus :: Lens' ListDatasetsResponse Int Source #

The response's http status code.

ListPermissionGroups

listPermissionGroups_nextToken :: Lens' ListPermissionGroups (Maybe Text) Source #

A token that indicates where a results page should begin.

listPermissionGroups_maxResults :: Lens' ListPermissionGroups Natural Source #

The maximum number of results per page.

listPermissionGroupsResponse_nextToken :: Lens' ListPermissionGroupsResponse (Maybe Text) Source #

A token that indicates where a results page should begin.

listPermissionGroupsResponse_permissionGroups :: Lens' ListPermissionGroupsResponse (Maybe [PermissionGroup]) Source #

A list of all the permission groups.

listPermissionGroupsResponse_httpStatus :: Lens' ListPermissionGroupsResponse Int Source #

The response's http status code.

ListPermissionGroupsByUser

listPermissionGroupsByUser_nextToken :: Lens' ListPermissionGroupsByUser (Maybe Text) Source #

A token that indicates where a results page should begin.

listPermissionGroupsByUser_userId :: Lens' ListPermissionGroupsByUser Text Source #

The unique identifier for the user.

listPermissionGroupsByUser_maxResults :: Lens' ListPermissionGroupsByUser Natural Source #

The maximum number of results per page.

listPermissionGroupsByUserResponse_nextToken :: Lens' ListPermissionGroupsByUserResponse (Maybe Text) Source #

A token that indicates where a results page should begin.

listPermissionGroupsByUserResponse_permissionGroups :: Lens' ListPermissionGroupsByUserResponse (Maybe [PermissionGroupByUser]) Source #

A list of returned permission groups.

listPermissionGroupsByUserResponse_httpStatus :: Lens' ListPermissionGroupsByUserResponse Int Source #

The response's http status code.

ListUsers

listUsers_nextToken :: Lens' ListUsers (Maybe Text) Source #

A token that indicates where a results page should begin.

listUsers_maxResults :: Lens' ListUsers Natural Source #

The maximum number of results per page.

listUsersResponse_nextToken :: Lens' ListUsersResponse (Maybe Text) Source #

A token that indicates where a results page should begin.

listUsersResponse_users :: Lens' ListUsersResponse (Maybe [User]) Source #

A list of all the user accounts.

listUsersResponse_httpStatus :: Lens' ListUsersResponse Int Source #

The response's http status code.

ListUsersByPermissionGroup

listUsersByPermissionGroup_nextToken :: Lens' ListUsersByPermissionGroup (Maybe Text) Source #

A token that indicates where a results page should begin.

listUsersByPermissionGroup_permissionGroupId :: Lens' ListUsersByPermissionGroup Text Source #

The unique identifier for the permission group.

listUsersByPermissionGroup_maxResults :: Lens' ListUsersByPermissionGroup Natural Source #

The maximum number of results per page.

listUsersByPermissionGroupResponse_nextToken :: Lens' ListUsersByPermissionGroupResponse (Maybe Text) Source #

A token that indicates where a results page should begin.

listUsersByPermissionGroupResponse_users :: Lens' ListUsersByPermissionGroupResponse (Maybe [UserByPermissionGroup]) Source #

Lists details of all users in a specific permission group.

listUsersByPermissionGroupResponse_httpStatus :: Lens' ListUsersByPermissionGroupResponse Int Source #

The response's http status code.

ResetUserPassword

resetUserPassword_clientToken :: Lens' ResetUserPassword (Maybe Text) Source #

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

resetUserPassword_userId :: Lens' ResetUserPassword Text Source #

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

resetUserPasswordResponse_temporaryPassword :: Lens' ResetUserPasswordResponse (Maybe Text) Source #

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

resetUserPasswordResponse_userId :: Lens' ResetUserPasswordResponse (Maybe Text) Source #

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

resetUserPasswordResponse_httpStatus :: Lens' ResetUserPasswordResponse Int Source #

The response's http status code.

UpdateChangeset

updateChangeset_clientToken :: Lens' UpdateChangeset (Maybe Text) Source #

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

updateChangeset_datasetId :: Lens' UpdateChangeset Text Source #

The unique identifier for the FinSpace Dataset in which the Changeset is created.

updateChangeset_changesetId :: Lens' UpdateChangeset Text Source #

The unique identifier for the Changeset to update.

updateChangeset_sourceParams :: Lens' UpdateChangeset (HashMap Text Text) Source #

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.

updateChangeset_formatParams :: Lens' UpdateChangeset (HashMap Text Text) Source #

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.

updateChangesetResponse_changesetId :: Lens' UpdateChangesetResponse (Maybe Text) Source #

The unique identifier for the Changeset to update.

updateChangesetResponse_datasetId :: Lens' UpdateChangesetResponse (Maybe Text) Source #

The unique identifier for the FinSpace Dataset in which the Changeset is created.

updateChangesetResponse_httpStatus :: Lens' UpdateChangesetResponse Int Source #

The response's http status code.

UpdateDataset

updateDataset_alias :: Lens' UpdateDataset (Maybe Text) Source #

The unique resource identifier for a Dataset.

updateDataset_clientToken :: Lens' UpdateDataset (Maybe Text) Source #

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

updateDataset_datasetDescription :: Lens' UpdateDataset (Maybe Text) Source #

A description for the Dataset.

updateDataset_schemaDefinition :: Lens' UpdateDataset (Maybe SchemaUnion) Source #

Definition for a schema on a tabular Dataset.

updateDataset_datasetId :: Lens' UpdateDataset Text Source #

The unique identifier for the Dataset to update.

updateDataset_datasetTitle :: Lens' UpdateDataset Text Source #

A display title for the Dataset.

updateDataset_kind :: Lens' UpdateDataset DatasetKind Source #

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.

updateDatasetResponse_datasetId :: Lens' UpdateDatasetResponse (Maybe Text) Source #

The unique identifier for updated Dataset.

updateDatasetResponse_httpStatus :: Lens' UpdateDatasetResponse Int Source #

The response's http status code.

UpdatePermissionGroup

updatePermissionGroup_applicationPermissions :: Lens' UpdatePermissionGroup (Maybe [ApplicationPermission]) Source #

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.

updatePermissionGroup_clientToken :: Lens' UpdatePermissionGroup (Maybe Text) Source #

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

updatePermissionGroup_description :: Lens' UpdatePermissionGroup (Maybe Text) Source #

A brief description for the permission group.

updatePermissionGroup_name :: Lens' UpdatePermissionGroup (Maybe Text) Source #

The name of the permission group.

updatePermissionGroup_permissionGroupId :: Lens' UpdatePermissionGroup Text Source #

The unique identifier for the permission group to update.

updatePermissionGroupResponse_permissionGroupId :: Lens' UpdatePermissionGroupResponse (Maybe Text) Source #

The unique identifier for the updated permission group.

updatePermissionGroupResponse_httpStatus :: Lens' UpdatePermissionGroupResponse Int Source #

The response's http status code.

UpdateUser

updateUser_apiAccess :: Lens' UpdateUser (Maybe ApiAccess) Source #

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.

updateUser_apiAccessPrincipalArn :: Lens' UpdateUser (Maybe Text) Source #

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.

updateUser_clientToken :: Lens' UpdateUser (Maybe Text) Source #

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

updateUser_firstName :: Lens' UpdateUser (Maybe Text) Source #

The first name of the user.

updateUser_lastName :: Lens' UpdateUser (Maybe Text) Source #

The last name of the user.

updateUser_type :: Lens' UpdateUser (Maybe UserType) Source #

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.

updateUser_userId :: Lens' UpdateUser Text Source #

The unique identifier for the user account to update.

updateUserResponse_userId :: Lens' UpdateUserResponse (Maybe Text) Source #

The unique identifier of the updated user account.

updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #

The response's http status code.

Types

AwsCredentials

awsCredentials_accessKeyId :: Lens' AwsCredentials (Maybe Text) Source #

The unique identifier for the security credentials.

awsCredentials_expiration :: Lens' AwsCredentials (Maybe Integer) Source #

The Epoch time when the current credentials expire.

awsCredentials_secretAccessKey :: Lens' AwsCredentials (Maybe Text) Source #

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

awsCredentials_sessionToken :: Lens' AwsCredentials (Maybe Text) Source #

The token that users must pass to use the credentials.

ChangesetErrorInfo

changesetErrorInfo_errorCategory :: Lens' ChangesetErrorInfo (Maybe ErrorCategory) Source #

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.

changesetErrorInfo_errorMessage :: Lens' ChangesetErrorInfo (Maybe Text) Source #

The text of the error message.

ChangesetSummary

changesetSummary_activeFromTimestamp :: Lens' ChangesetSummary (Maybe Integer) Source #

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.

changesetSummary_activeUntilTimestamp :: Lens' ChangesetSummary (Maybe Integer) Source #

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_changeType :: Lens' ChangesetSummary (Maybe ChangeType) Source #

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.

changesetSummary_changesetArn :: Lens' ChangesetSummary (Maybe Text) Source #

The ARN identifier of the Changeset.

changesetSummary_changesetId :: Lens' ChangesetSummary (Maybe Text) Source #

The unique identifier for a Changeset.

changesetSummary_createTime :: Lens' ChangesetSummary (Maybe Integer) Source #

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_datasetId :: Lens' ChangesetSummary (Maybe Text) Source #

The unique identifier for the FinSpace Dataset in which the Changeset is created.

changesetSummary_errorInfo :: Lens' ChangesetSummary (Maybe ChangesetErrorInfo) Source #

The structure with error messages.

changesetSummary_formatParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text)) Source #

Options that define the structure of the source file(s).

changesetSummary_sourceParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text)) Source #

Options that define the location of the data being ingested.

changesetSummary_status :: Lens' ChangesetSummary (Maybe IngestionStatus) Source #

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.

changesetSummary_updatedByChangesetId :: Lens' ChangesetSummary (Maybe Text) Source #

The unique identifier of the updated Changeset.

changesetSummary_updatesChangesetId :: Lens' ChangesetSummary (Maybe Text) Source #

The unique identifier of the Changeset that is updated.

ColumnDefinition

columnDefinition_columnDescription :: Lens' ColumnDefinition (Maybe Text) Source #

Description for a column.

columnDefinition_columnName :: Lens' ColumnDefinition (Maybe Text) Source #

The name of a column.

columnDefinition_dataType :: Lens' ColumnDefinition (Maybe ColumnDataType) Source #

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.

Credentials

credentials_accessKeyId :: Lens' Credentials (Maybe Text) Source #

The access key identifier.

credentials_secretAccessKey :: Lens' Credentials (Maybe Text) Source #

The access key.

credentials_sessionToken :: Lens' Credentials (Maybe Text) Source #

The session token.

DataViewDestinationTypeParams

dataViewDestinationTypeParams_s3DestinationExportFileFormat :: Lens' DataViewDestinationTypeParams (Maybe ExportFileFormat) Source #

Dataview export file format.

PARQUET – Parquet export file format.
DELIMITED_TEXT – Delimited text export file format.

dataViewDestinationTypeParams_s3DestinationExportFileFormatOptions :: Lens' DataViewDestinationTypeParams (Maybe (HashMap Text Text)) Source #

Format Options for S3 Destination type.

Here is an example of how you could specify the s3DestinationExportFileFormatOptions

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

dataViewDestinationTypeParams_destinationType :: Lens' DataViewDestinationTypeParams Text Source #

Destination type for a Dataview.

GLUE_TABLE – Glue table destination type.
S3 – S3 destination type.

DataViewErrorInfo

dataViewErrorInfo_errorCategory :: Lens' DataViewErrorInfo (Maybe ErrorCategory) Source #

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.

dataViewErrorInfo_errorMessage :: Lens' DataViewErrorInfo (Maybe Text) Source #

The text of the error message.

DataViewSummary

dataViewSummary_asOfTimestamp :: Lens' DataViewSummary (Maybe Integer) Source #

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_autoUpdate :: Lens' DataViewSummary (Maybe Bool) Source #

The flag to indicate Dataview should be updated automatically.

dataViewSummary_createTime :: Lens' DataViewSummary (Maybe Integer) Source #

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_dataViewArn :: Lens' DataViewSummary (Maybe Text) Source #

The ARN identifier of the Dataview.

dataViewSummary_dataViewId :: Lens' DataViewSummary (Maybe Text) Source #

The unique identifier for the Dataview.

dataViewSummary_datasetId :: Lens' DataViewSummary (Maybe Text) Source #

Th unique identifier for the Dataview Dataset.

dataViewSummary_destinationTypeProperties :: Lens' DataViewSummary (Maybe DataViewDestinationTypeParams) Source #

Information about the Dataview destination.

dataViewSummary_errorInfo :: Lens' DataViewSummary (Maybe DataViewErrorInfo) Source #

The structure with error messages.

dataViewSummary_lastModifiedTime :: Lens' DataViewSummary (Maybe Integer) Source #

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.

dataViewSummary_partitionColumns :: Lens' DataViewSummary (Maybe [Text]) Source #

Ordered set of column names used to partition data.

dataViewSummary_sortColumns :: Lens' DataViewSummary (Maybe [Text]) Source #

Columns to be used for sorting the data.

dataViewSummary_status :: Lens' DataViewSummary (Maybe DataViewStatus) Source #

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.

Dataset

dataset_alias :: Lens' Dataset (Maybe Text) Source #

The unique resource identifier for a Dataset.

dataset_createTime :: Lens' Dataset (Maybe Integer) Source #

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_datasetArn :: Lens' Dataset (Maybe Text) Source #

The ARN identifier of the Dataset.

dataset_datasetDescription :: Lens' Dataset (Maybe Text) Source #

Description for a Dataset.

dataset_datasetId :: Lens' Dataset (Maybe Text) Source #

An identifier for a Dataset.

dataset_datasetTitle :: Lens' Dataset (Maybe Text) Source #

Display title for a Dataset.

dataset_kind :: Lens' Dataset (Maybe DatasetKind) Source #

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.

dataset_lastModifiedTime :: Lens' Dataset (Maybe Integer) Source #

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.

dataset_ownerInfo :: Lens' Dataset (Maybe DatasetOwnerInfo) Source #

Contact information for a Dataset owner.

dataset_schemaDefinition :: Lens' Dataset (Maybe SchemaUnion) Source #

Definition for a schema on a tabular Dataset.

DatasetOwnerInfo

datasetOwnerInfo_email :: Lens' DatasetOwnerInfo (Maybe Text) Source #

Email address for the Dataset owner.

datasetOwnerInfo_name :: Lens' DatasetOwnerInfo (Maybe Text) Source #

The name of the Dataset owner.

datasetOwnerInfo_phoneNumber :: Lens' DatasetOwnerInfo (Maybe Text) Source #

Phone number for the Dataset owner.

PermissionGroup

permissionGroup_applicationPermissions :: Lens' PermissionGroup (Maybe [ApplicationPermission]) Source #

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.

permissionGroup_createTime :: Lens' PermissionGroup (Maybe Integer) Source #

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

permissionGroup_description :: Lens' PermissionGroup (Maybe Text) Source #

A brief description for the permission group.

permissionGroup_lastModifiedTime :: Lens' PermissionGroup (Maybe Integer) Source #

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

permissionGroup_membershipStatus :: Lens' PermissionGroup (Maybe PermissionGroupMembershipStatus) Source #

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.

permissionGroup_name :: Lens' PermissionGroup (Maybe Text) Source #

The name of the permission group.

permissionGroup_permissionGroupId :: Lens' PermissionGroup (Maybe Text) Source #

The unique identifier for the permission group.

PermissionGroupByUser

permissionGroupByUser_membershipStatus :: Lens' PermissionGroupByUser (Maybe PermissionGroupMembershipStatus) Source #

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.

permissionGroupByUser_name :: Lens' PermissionGroupByUser (Maybe Text) Source #

The name of the permission group.

permissionGroupByUser_permissionGroupId :: Lens' PermissionGroupByUser (Maybe Text) Source #

The unique identifier for the permission group.

PermissionGroupParams

permissionGroupParams_datasetPermissions :: Lens' PermissionGroupParams (Maybe [ResourcePermission]) Source #

List of resource permissions.

permissionGroupParams_permissionGroupId :: Lens' PermissionGroupParams (Maybe Text) Source #

The unique identifier for the PermissionGroup.

ResourcePermission

resourcePermission_permission :: Lens' ResourcePermission (Maybe Text) Source #

Permission for a resource.

S3Location

s3Location_bucket :: Lens' S3Location Text Source #

The name of the S3 bucket.

s3Location_key :: Lens' S3Location Text Source #

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

SchemaDefinition

schemaDefinition_columns :: Lens' SchemaDefinition (Maybe [ColumnDefinition]) Source #

List of column definitions.

schemaDefinition_primaryKeyColumns :: Lens' SchemaDefinition (Maybe [Text]) Source #

List of column names used for primary key.

SchemaUnion

schemaUnion_tabularSchemaConfig :: Lens' SchemaUnion (Maybe SchemaDefinition) Source #

The configuration for a schema on a tabular Dataset.

User

user_apiAccess :: Lens' User (Maybe ApiAccess) Source #

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.

user_apiAccessPrincipalArn :: Lens' User (Maybe Text) Source #

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.

user_createTime :: Lens' User (Maybe Integer) Source #

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

user_emailAddress :: Lens' User (Maybe Text) Source #

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.

user_firstName :: Lens' User (Maybe Text) Source #

The first name of the user.

user_lastDisabledTime :: Lens' User (Maybe Integer) Source #

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

user_lastEnabledTime :: Lens' User (Maybe Integer) Source #

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

user_lastLoginTime :: Lens' User (Maybe Integer) Source #

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

user_lastModifiedTime :: Lens' User (Maybe Integer) Source #

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

user_lastName :: Lens' User (Maybe Text) Source #

The last name of the user.

user_status :: Lens' User (Maybe UserStatus) Source #

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.

user_type :: Lens' User (Maybe UserType) Source #

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.

user_userId :: Lens' User (Maybe Text) Source #

The unique identifier for the user.

UserByPermissionGroup

userByPermissionGroup_apiAccess :: Lens' UserByPermissionGroup (Maybe ApiAccess) Source #

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.

userByPermissionGroup_apiAccessPrincipalArn :: Lens' UserByPermissionGroup (Maybe Text) Source #

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

userByPermissionGroup_emailAddress :: Lens' UserByPermissionGroup (Maybe Text) Source #

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.

userByPermissionGroup_firstName :: Lens' UserByPermissionGroup (Maybe Text) Source #

The first name of the user.

userByPermissionGroup_lastName :: Lens' UserByPermissionGroup (Maybe Text) Source #

The last name of the user.

userByPermissionGroup_membershipStatus :: Lens' UserByPermissionGroup (Maybe PermissionGroupMembershipStatus) Source #

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.

userByPermissionGroup_status :: Lens' UserByPermissionGroup (Maybe UserStatus) Source #

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.

userByPermissionGroup_type :: Lens' UserByPermissionGroup (Maybe UserType) Source #

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.

userByPermissionGroup_userId :: Lens' UserByPermissionGroup (Maybe Text) Source #

The unique identifier for the user.