| 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
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AssociateUserToPermissionGroup
- CreateChangeset
- CreateDataView
- CreateDataset
- CreatePermissionGroup
- CreateUser
- DeleteDataset
- DeletePermissionGroup
- DisableUser
- DisassociateUserFromPermissionGroup
- EnableUser
- GetChangeset
- GetDataView
- GetDataset
- GetExternalDataViewAccessDetails
- GetPermissionGroup
- GetProgrammaticAccessCredentials
- GetUser
- GetWorkingLocation
- ListChangesets (Paginated)
- ListDataViews (Paginated)
- ListDatasets (Paginated)
- ListPermissionGroups (Paginated)
- ListPermissionGroupsByUser
- ListUsers (Paginated)
- ListUsersByPermissionGroup
- ResetUserPassword
- UpdateChangeset
- UpdateDataset
- UpdatePermissionGroup
- UpdateUser
- Types
- ApiAccess
- ApplicationPermission
- ChangeType
- ColumnDataType
- DataViewStatus
- DatasetKind
- DatasetStatus
- ErrorCategory
- ExportFileFormat
- IngestionStatus
- LocationType
- PermissionGroupMembershipStatus
- UserStatus
- UserType
- AwsCredentials
- ChangesetErrorInfo
- ChangesetSummary
- ColumnDefinition
- Credentials
- DataViewDestinationTypeParams
- DataViewErrorInfo
- DataViewSummary
- Dataset
- DatasetOwnerInfo
- PermissionGroup
- PermissionGroupByUser
- PermissionGroupParams
- ResourcePermission
- S3Location
- SchemaDefinition
- SchemaUnion
- User
- UserByPermissionGroup
Description
Derived from API version 2020-07-13 of the AWS service descriptions, licensed under Apache 2.0.
The FinSpace APIs let you take actions inside the FinSpace.
Synopsis
- defaultService :: Service
- _AccessDeniedException :: AsError a => Fold a ServiceError
- _ConflictException :: AsError a => Fold a ServiceError
- _InternalServerException :: AsError a => Fold a ServiceError
- _LimitExceededException :: AsError a => Fold a ServiceError
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ThrottlingException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- data AssociateUserToPermissionGroup = AssociateUserToPermissionGroup' (Maybe Text) Text Text
- newAssociateUserToPermissionGroup :: Text -> Text -> AssociateUserToPermissionGroup
- data AssociateUserToPermissionGroupResponse = AssociateUserToPermissionGroupResponse' Int
- newAssociateUserToPermissionGroupResponse :: Int -> AssociateUserToPermissionGroupResponse
- data CreateChangeset = CreateChangeset' (Maybe Text) Text ChangeType (HashMap Text Text) (HashMap Text Text)
- newCreateChangeset :: Text -> ChangeType -> CreateChangeset
- data CreateChangesetResponse = CreateChangesetResponse' (Maybe Text) (Maybe Text) Int
- newCreateChangesetResponse :: Int -> CreateChangesetResponse
- data CreateDataView = CreateDataView' (Maybe Integer) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) Text DataViewDestinationTypeParams
- newCreateDataView :: Text -> DataViewDestinationTypeParams -> CreateDataView
- data CreateDataViewResponse = CreateDataViewResponse' (Maybe Text) (Maybe Text) Int
- newCreateDataViewResponse :: Int -> CreateDataViewResponse
- data CreateDataset = CreateDataset' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetOwnerInfo) (Maybe SchemaUnion) Text DatasetKind PermissionGroupParams
- newCreateDataset :: Text -> DatasetKind -> PermissionGroupParams -> CreateDataset
- data CreateDatasetResponse = CreateDatasetResponse' (Maybe Text) Int
- newCreateDatasetResponse :: Int -> CreateDatasetResponse
- data CreatePermissionGroup = CreatePermissionGroup' (Maybe Text) (Maybe (Sensitive Text)) (Sensitive Text) [ApplicationPermission]
- newCreatePermissionGroup :: Text -> CreatePermissionGroup
- data CreatePermissionGroupResponse = CreatePermissionGroupResponse' (Maybe Text) Int
- newCreatePermissionGroupResponse :: Int -> CreatePermissionGroupResponse
- data CreateUser = CreateUser' (Maybe ApiAccess) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Sensitive Text) UserType
- newCreateUser :: Text -> UserType -> CreateUser
- data CreateUserResponse = CreateUserResponse' (Maybe Text) Int
- newCreateUserResponse :: Int -> CreateUserResponse
- data DeleteDataset = DeleteDataset' (Maybe Text) Text
- newDeleteDataset :: Text -> DeleteDataset
- data DeleteDatasetResponse = DeleteDatasetResponse' (Maybe Text) Int
- newDeleteDatasetResponse :: Int -> DeleteDatasetResponse
- data DeletePermissionGroup = DeletePermissionGroup' (Maybe Text) Text
- newDeletePermissionGroup :: Text -> DeletePermissionGroup
- data DeletePermissionGroupResponse = DeletePermissionGroupResponse' (Maybe Text) Int
- newDeletePermissionGroupResponse :: Int -> DeletePermissionGroupResponse
- data DisableUser = DisableUser' (Maybe Text) Text
- newDisableUser :: Text -> DisableUser
- data DisableUserResponse = DisableUserResponse' (Maybe Text) Int
- newDisableUserResponse :: Int -> DisableUserResponse
- data DisassociateUserFromPermissionGroup = DisassociateUserFromPermissionGroup' (Maybe Text) Text Text
- newDisassociateUserFromPermissionGroup :: Text -> Text -> DisassociateUserFromPermissionGroup
- data DisassociateUserFromPermissionGroupResponse = DisassociateUserFromPermissionGroupResponse' Int
- newDisassociateUserFromPermissionGroupResponse :: Int -> DisassociateUserFromPermissionGroupResponse
- data EnableUser = EnableUser' (Maybe Text) Text
- newEnableUser :: Text -> EnableUser
- data EnableUserResponse = EnableUserResponse' (Maybe Text) Int
- newEnableUserResponse :: Int -> EnableUserResponse
- data GetChangeset = GetChangeset' Text Text
- newGetChangeset :: Text -> Text -> GetChangeset
- data GetChangesetResponse = GetChangesetResponse' (Maybe Integer) (Maybe Integer) (Maybe ChangeType) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe ChangesetErrorInfo) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe IngestionStatus) (Maybe Text) (Maybe Text) Int
- newGetChangesetResponse :: Int -> GetChangesetResponse
- data GetDataView = GetDataView' Text Text
- newGetDataView :: Text -> Text -> GetDataView
- data GetDataViewResponse = GetDataViewResponse' (Maybe Integer) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataViewDestinationTypeParams) (Maybe DataViewErrorInfo) (Maybe Integer) (Maybe [Text]) (Maybe [Text]) (Maybe DataViewStatus) Int
- newGetDataViewResponse :: Int -> GetDataViewResponse
- data GetDataset = GetDataset' Text
- newGetDataset :: Text -> GetDataset
- data GetDatasetResponse = GetDatasetResponse' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetKind) (Maybe Integer) (Maybe SchemaUnion) (Maybe DatasetStatus) Int
- newGetDatasetResponse :: Int -> GetDatasetResponse
- data GetExternalDataViewAccessDetails = GetExternalDataViewAccessDetails' Text Text
- newGetExternalDataViewAccessDetails :: Text -> Text -> GetExternalDataViewAccessDetails
- data GetExternalDataViewAccessDetailsResponse = GetExternalDataViewAccessDetailsResponse' (Maybe AwsCredentials) (Maybe S3Location) Int
- newGetExternalDataViewAccessDetailsResponse :: Int -> GetExternalDataViewAccessDetailsResponse
- data GetPermissionGroup = GetPermissionGroup' Text
- newGetPermissionGroup :: Text -> GetPermissionGroup
- data GetPermissionGroupResponse = GetPermissionGroupResponse' (Maybe PermissionGroup) Int
- newGetPermissionGroupResponse :: Int -> GetPermissionGroupResponse
- data GetProgrammaticAccessCredentials = GetProgrammaticAccessCredentials' (Maybe Natural) Text
- newGetProgrammaticAccessCredentials :: Text -> GetProgrammaticAccessCredentials
- data GetProgrammaticAccessCredentialsResponse = GetProgrammaticAccessCredentialsResponse' (Maybe Credentials) (Maybe Natural) Int
- newGetProgrammaticAccessCredentialsResponse :: Int -> GetProgrammaticAccessCredentialsResponse
- data GetUser = GetUser' Text
- newGetUser :: Text -> GetUser
- data GetUserResponse = GetUserResponse' (Maybe ApiAccess) (Maybe Text) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe UserStatus) (Maybe UserType) (Maybe Text) Int
- newGetUserResponse :: Int -> GetUserResponse
- data GetWorkingLocation = GetWorkingLocation' (Maybe LocationType)
- newGetWorkingLocation :: GetWorkingLocation
- data GetWorkingLocationResponse = GetWorkingLocationResponse' (Maybe Text) (Maybe Text) (Maybe Text) Int
- newGetWorkingLocationResponse :: Int -> GetWorkingLocationResponse
- data ListChangesets = ListChangesets' (Maybe Natural) (Maybe Text) Text
- newListChangesets :: Text -> ListChangesets
- data ListChangesetsResponse = ListChangesetsResponse' (Maybe [ChangesetSummary]) (Maybe Text) Int
- newListChangesetsResponse :: Int -> ListChangesetsResponse
- data ListDataViews = ListDataViews' (Maybe Natural) (Maybe Text) Text
- newListDataViews :: Text -> ListDataViews
- data ListDataViewsResponse = ListDataViewsResponse' (Maybe [DataViewSummary]) (Maybe Text) Int
- newListDataViewsResponse :: Int -> ListDataViewsResponse
- data ListDatasets = ListDatasets' (Maybe Natural) (Maybe Text)
- newListDatasets :: ListDatasets
- data ListDatasetsResponse = ListDatasetsResponse' (Maybe [Dataset]) (Maybe Text) Int
- newListDatasetsResponse :: Int -> ListDatasetsResponse
- data ListPermissionGroups = ListPermissionGroups' (Maybe Text) Natural
- newListPermissionGroups :: Natural -> ListPermissionGroups
- data ListPermissionGroupsResponse = ListPermissionGroupsResponse' (Maybe Text) (Maybe [PermissionGroup]) Int
- newListPermissionGroupsResponse :: Int -> ListPermissionGroupsResponse
- data ListPermissionGroupsByUser = ListPermissionGroupsByUser' (Maybe Text) Text Natural
- newListPermissionGroupsByUser :: Text -> Natural -> ListPermissionGroupsByUser
- data ListPermissionGroupsByUserResponse = ListPermissionGroupsByUserResponse' (Maybe Text) (Maybe [PermissionGroupByUser]) Int
- newListPermissionGroupsByUserResponse :: Int -> ListPermissionGroupsByUserResponse
- data ListUsers = ListUsers' (Maybe Text) Natural
- newListUsers :: Natural -> ListUsers
- data ListUsersResponse = ListUsersResponse' (Maybe Text) (Maybe [User]) Int
- newListUsersResponse :: Int -> ListUsersResponse
- data ListUsersByPermissionGroup = ListUsersByPermissionGroup' (Maybe Text) Text Natural
- newListUsersByPermissionGroup :: Text -> Natural -> ListUsersByPermissionGroup
- data ListUsersByPermissionGroupResponse = ListUsersByPermissionGroupResponse' (Maybe Text) (Maybe [UserByPermissionGroup]) Int
- newListUsersByPermissionGroupResponse :: Int -> ListUsersByPermissionGroupResponse
- data ResetUserPassword = ResetUserPassword' (Maybe Text) Text
- newResetUserPassword :: Text -> ResetUserPassword
- data ResetUserPasswordResponse = ResetUserPasswordResponse' (Maybe (Sensitive Text)) (Maybe Text) Int
- newResetUserPasswordResponse :: Int -> ResetUserPasswordResponse
- data UpdateChangeset = UpdateChangeset' (Maybe Text) Text Text (HashMap Text Text) (HashMap Text Text)
- newUpdateChangeset :: Text -> Text -> UpdateChangeset
- data UpdateChangesetResponse = UpdateChangesetResponse' (Maybe Text) (Maybe Text) Int
- newUpdateChangesetResponse :: Int -> UpdateChangesetResponse
- data UpdateDataset = UpdateDataset' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SchemaUnion) Text Text DatasetKind
- newUpdateDataset :: Text -> Text -> DatasetKind -> UpdateDataset
- data UpdateDatasetResponse = UpdateDatasetResponse' (Maybe Text) Int
- newUpdateDatasetResponse :: Int -> UpdateDatasetResponse
- data UpdatePermissionGroup = UpdatePermissionGroup' (Maybe [ApplicationPermission]) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text
- newUpdatePermissionGroup :: Text -> UpdatePermissionGroup
- data UpdatePermissionGroupResponse = UpdatePermissionGroupResponse' (Maybe Text) Int
- newUpdatePermissionGroupResponse :: Int -> UpdatePermissionGroupResponse
- data UpdateUser = UpdateUser' (Maybe ApiAccess) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe UserType) Text
- newUpdateUser :: Text -> UpdateUser
- data UpdateUserResponse = UpdateUserResponse' (Maybe Text) Int
- newUpdateUserResponse :: Int -> UpdateUserResponse
- newtype ApiAccess where
- ApiAccess' { }
- pattern ApiAccess_DISABLED :: ApiAccess
- pattern ApiAccess_ENABLED :: ApiAccess
- newtype ApplicationPermission where
- ApplicationPermission' { }
- pattern ApplicationPermission_AccessNotebooks :: ApplicationPermission
- pattern ApplicationPermission_CreateDataset :: ApplicationPermission
- pattern ApplicationPermission_GetTemporaryCredentials :: ApplicationPermission
- pattern ApplicationPermission_ManageAttributeSets :: ApplicationPermission
- pattern ApplicationPermission_ManageClusters :: ApplicationPermission
- pattern ApplicationPermission_ManageUsersAndGroups :: ApplicationPermission
- pattern ApplicationPermission_ViewAuditData :: ApplicationPermission
- newtype ChangeType where
- ChangeType' { }
- pattern ChangeType_APPEND :: ChangeType
- pattern ChangeType_MODIFY :: ChangeType
- pattern ChangeType_REPLACE :: ChangeType
- newtype ColumnDataType where
- ColumnDataType' { }
- pattern ColumnDataType_BIGINT :: ColumnDataType
- pattern ColumnDataType_BINARY :: ColumnDataType
- pattern ColumnDataType_BOOLEAN :: ColumnDataType
- pattern ColumnDataType_CHAR :: ColumnDataType
- pattern ColumnDataType_DATE :: ColumnDataType
- pattern ColumnDataType_DATETIME :: ColumnDataType
- pattern ColumnDataType_DOUBLE :: ColumnDataType
- pattern ColumnDataType_FLOAT :: ColumnDataType
- pattern ColumnDataType_INTEGER :: ColumnDataType
- pattern ColumnDataType_SMALLINT :: ColumnDataType
- pattern ColumnDataType_STRING :: ColumnDataType
- pattern ColumnDataType_TINYINT :: ColumnDataType
- newtype DataViewStatus where
- DataViewStatus' { }
- pattern DataViewStatus_CANCELLED :: DataViewStatus
- pattern DataViewStatus_FAILED :: DataViewStatus
- pattern DataViewStatus_FAILED_CLEANUP_FAILED :: DataViewStatus
- pattern DataViewStatus_PENDING :: DataViewStatus
- pattern DataViewStatus_RUNNING :: DataViewStatus
- pattern DataViewStatus_STARTING :: DataViewStatus
- pattern DataViewStatus_SUCCESS :: DataViewStatus
- pattern DataViewStatus_TIMEOUT :: DataViewStatus
- newtype DatasetKind where
- DatasetKind' { }
- pattern DatasetKind_NON_TABULAR :: DatasetKind
- pattern DatasetKind_TABULAR :: DatasetKind
- newtype DatasetStatus where
- DatasetStatus' { }
- pattern DatasetStatus_FAILED :: DatasetStatus
- pattern DatasetStatus_PENDING :: DatasetStatus
- pattern DatasetStatus_RUNNING :: DatasetStatus
- pattern DatasetStatus_SUCCESS :: DatasetStatus
- newtype ErrorCategory where
- ErrorCategory' { }
- pattern ErrorCategory_ACCESS_DENIED :: ErrorCategory
- pattern ErrorCategory_CANCELLED :: ErrorCategory
- pattern ErrorCategory_INTERNAL_SERVICE_EXCEPTION :: ErrorCategory
- pattern ErrorCategory_RESOURCE_NOT_FOUND :: ErrorCategory
- pattern ErrorCategory_SERVICE_QUOTA_EXCEEDED :: ErrorCategory
- pattern ErrorCategory_THROTTLING :: ErrorCategory
- pattern ErrorCategory_USER_RECOVERABLE :: ErrorCategory
- pattern ErrorCategory_VALIDATION :: ErrorCategory
- newtype ExportFileFormat where
- ExportFileFormat' { }
- pattern ExportFileFormat_DELIMITED_TEXT :: ExportFileFormat
- pattern ExportFileFormat_PARQUET :: ExportFileFormat
- newtype IngestionStatus where
- IngestionStatus' { }
- pattern IngestionStatus_FAILED :: IngestionStatus
- pattern IngestionStatus_PENDING :: IngestionStatus
- pattern IngestionStatus_RUNNING :: IngestionStatus
- pattern IngestionStatus_STOP_REQUESTED :: IngestionStatus
- pattern IngestionStatus_SUCCESS :: IngestionStatus
- newtype LocationType where
- LocationType' { }
- pattern LocationType_INGESTION :: LocationType
- pattern LocationType_SAGEMAKER :: LocationType
- newtype PermissionGroupMembershipStatus where
- PermissionGroupMembershipStatus' { }
- pattern PermissionGroupMembershipStatus_ADDITION_IN_PROGRESS :: PermissionGroupMembershipStatus
- pattern PermissionGroupMembershipStatus_ADDITION_SUCCESS :: PermissionGroupMembershipStatus
- pattern PermissionGroupMembershipStatus_REMOVAL_IN_PROGRESS :: PermissionGroupMembershipStatus
- newtype UserStatus where
- UserStatus' { }
- pattern UserStatus_CREATING :: UserStatus
- pattern UserStatus_DISABLED :: UserStatus
- pattern UserStatus_ENABLED :: UserStatus
- newtype UserType where
- UserType' {
- fromUserType :: Text
- pattern UserType_APP_USER :: UserType
- pattern UserType_SUPER_USER :: UserType
- UserType' {
- data AwsCredentials = AwsCredentials' (Maybe Text) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe (Sensitive Text))
- newAwsCredentials :: AwsCredentials
- data ChangesetErrorInfo = ChangesetErrorInfo' (Maybe ErrorCategory) (Maybe Text)
- newChangesetErrorInfo :: ChangesetErrorInfo
- data ChangesetSummary = ChangesetSummary' (Maybe Integer) (Maybe Integer) (Maybe ChangeType) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe ChangesetErrorInfo) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe IngestionStatus) (Maybe Text) (Maybe Text)
- newChangesetSummary :: ChangesetSummary
- data ColumnDefinition = ColumnDefinition' (Maybe Text) (Maybe Text) (Maybe ColumnDataType)
- newColumnDefinition :: ColumnDefinition
- data Credentials = Credentials' (Maybe Text) (Maybe Text) (Maybe Text)
- newCredentials :: Credentials
- data DataViewDestinationTypeParams = DataViewDestinationTypeParams' (Maybe ExportFileFormat) (Maybe (HashMap Text Text)) Text
- newDataViewDestinationTypeParams :: Text -> DataViewDestinationTypeParams
- data DataViewErrorInfo = DataViewErrorInfo' (Maybe ErrorCategory) (Maybe Text)
- newDataViewErrorInfo :: DataViewErrorInfo
- data DataViewSummary = DataViewSummary' (Maybe Integer) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataViewDestinationTypeParams) (Maybe DataViewErrorInfo) (Maybe Integer) (Maybe [Text]) (Maybe [Text]) (Maybe DataViewStatus)
- newDataViewSummary :: DataViewSummary
- data Dataset = Dataset' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetKind) (Maybe Integer) (Maybe DatasetOwnerInfo) (Maybe SchemaUnion)
- newDataset :: Dataset
- data DatasetOwnerInfo = DatasetOwnerInfo' (Maybe (Sensitive Text)) (Maybe Text) (Maybe Text)
- newDatasetOwnerInfo :: DatasetOwnerInfo
- data PermissionGroup = PermissionGroup' (Maybe [ApplicationPermission]) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe PermissionGroupMembershipStatus) (Maybe (Sensitive Text)) (Maybe Text)
- newPermissionGroup :: PermissionGroup
- data PermissionGroupByUser = PermissionGroupByUser' (Maybe PermissionGroupMembershipStatus) (Maybe (Sensitive Text)) (Maybe Text)
- newPermissionGroupByUser :: PermissionGroupByUser
- data PermissionGroupParams = PermissionGroupParams' (Maybe [ResourcePermission]) (Maybe Text)
- newPermissionGroupParams :: PermissionGroupParams
- data ResourcePermission = ResourcePermission' (Maybe Text)
- newResourcePermission :: ResourcePermission
- data S3Location = S3Location' Text Text
- newS3Location :: Text -> Text -> S3Location
- data SchemaDefinition = SchemaDefinition' (Maybe [ColumnDefinition]) (Maybe [Text])
- newSchemaDefinition :: SchemaDefinition
- data SchemaUnion = SchemaUnion' (Maybe SchemaDefinition)
- newSchemaUnion :: SchemaUnion
- data User = User' (Maybe ApiAccess) (Maybe Text) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe UserStatus) (Maybe UserType) (Maybe Text)
- newUser :: User
- data UserByPermissionGroup = UserByPermissionGroup' (Maybe ApiAccess) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe PermissionGroupMembershipStatus) (Maybe UserStatus) (Maybe UserType) (Maybe Text)
- newUserByPermissionGroup :: UserByPermissionGroup
Service Configuration
defaultService :: Service Source #
API version 2020-07-13 of the Amazon FinSpace Public API SDK configuration.
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by FinSpaceData.
AccessDeniedException
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
ConflictException
_ConflictException :: AsError a => Fold a ServiceError Source #
The request conflicts with an existing resource.
InternalServerException
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure.
LimitExceededException
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A limit has exceeded.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
One or more resources can't be found.
ThrottlingException
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
AssociateUserToPermissionGroup
data AssociateUserToPermissionGroup Source #
See: newAssociateUserToPermissionGroup smart constructor.
Constructors
| AssociateUserToPermissionGroup' (Maybe Text) Text Text |
Instances
newAssociateUserToPermissionGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> AssociateUserToPermissionGroup |
Create a value of AssociateUserToPermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:AssociateUserToPermissionGroup', associateUserToPermissionGroup_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
AssociateUserToPermissionGroup, associateUserToPermissionGroup_permissionGroupId - The unique identifier for the permission group.
AssociateUserToPermissionGroup, associateUserToPermissionGroup_userId - The unique identifier for the user.
data AssociateUserToPermissionGroupResponse Source #
See: newAssociateUserToPermissionGroupResponse smart constructor.
Constructors
| AssociateUserToPermissionGroupResponse' Int |
Instances
newAssociateUserToPermissionGroupResponse Source #
Arguments
| :: Int | |
| -> AssociateUserToPermissionGroupResponse |
Create a value of AssociateUserToPermissionGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:statusCode:AssociateUserToPermissionGroupResponse', associateUserToPermissionGroupResponse_statusCode - The returned status code of the response.
CreateChangeset
data CreateChangeset Source #
The request for a CreateChangeset operation.
See: newCreateChangeset smart constructor.
Instances
Arguments
| :: Text | |
| -> ChangeType | |
| -> CreateChangeset |
Create a value of CreateChangeset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateChangeset', createChangeset_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
CreateChangeset, createChangeset_datasetId - The unique identifier for the FinSpace Dataset where the Changeset will
be created.
CreateChangeset, createChangeset_changeType - 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, createChangeset_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.
CreateChangeset, createChangeset_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.
data CreateChangesetResponse Source #
The response from a CreateChangeset operation.
See: newCreateChangesetResponse smart constructor.
Instances
newCreateChangesetResponse Source #
Create a value of CreateChangesetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChangesetResponse, createChangesetResponse_changesetId - The unique identifier of the Changeset that is created.
CreateChangeset, createChangesetResponse_datasetId - The unique identifier for the FinSpace Dataset where the Changeset is
created.
$sel:httpStatus:CreateChangesetResponse', createChangesetResponse_httpStatus - The response's http status code.
CreateDataView
data CreateDataView Source #
Request for creating a data view.
See: newCreateDataView smart constructor.
Constructors
| CreateDataView' (Maybe Integer) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe [Text]) Text DataViewDestinationTypeParams |
Instances
Arguments
| :: Text | |
| -> DataViewDestinationTypeParams | |
| -> CreateDataView |
Create a value of CreateDataView with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDataView, createDataView_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.
CreateDataView, createDataView_autoUpdate - Flag to indicate Dataview should be updated automatically.
$sel:clientToken:CreateDataView', createDataView_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
CreateDataView, createDataView_partitionColumns - Ordered set of column names used to partition data.
CreateDataView, createDataView_sortColumns - Columns to be used for sorting the data.
CreateDataView, createDataView_datasetId - The unique Dataset identifier that is used to create a Dataview.
$sel:destinationTypeParams:CreateDataView', createDataView_destinationTypeParams - Options that define the destination type for the Dataview.
data CreateDataViewResponse Source #
Response for creating a data view.
See: newCreateDataViewResponse smart constructor.
Instances
newCreateDataViewResponse Source #
Create a value of CreateDataViewResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDataViewResponse, createDataViewResponse_dataViewId - The unique identifier for the created Dataview.
CreateDataView, createDataViewResponse_datasetId - The unique identifier of the Dataset used for the Dataview.
$sel:httpStatus:CreateDataViewResponse', createDataViewResponse_httpStatus - The response's http status code.
CreateDataset
data CreateDataset Source #
The request for a CreateDataset operation
See: newCreateDataset smart constructor.
Constructors
| CreateDataset' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetOwnerInfo) (Maybe SchemaUnion) Text DatasetKind PermissionGroupParams |
Instances
Arguments
| :: Text | |
| -> DatasetKind | |
| -> PermissionGroupParams | |
| -> CreateDataset |
Create a value of CreateDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDataset, createDataset_alias - The unique resource identifier for a Dataset.
$sel:clientToken:CreateDataset', createDataset_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
CreateDataset, createDataset_datasetDescription - Description of a Dataset.
CreateDataset, createDataset_ownerInfo - Contact information for a Dataset owner.
CreateDataset, createDataset_schemaDefinition - Definition for a schema on a tabular Dataset.
CreateDataset, createDataset_datasetTitle - Display title for a FinSpace Dataset.
CreateDataset, createDataset_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.
$sel:permissionGroupParams:CreateDataset', createDataset_permissionGroupParams - Permission group parameters for Dataset permissions.
data CreateDatasetResponse Source #
The response from a CreateDataset operation
See: newCreateDatasetResponse smart constructor.
Constructors
| CreateDatasetResponse' (Maybe Text) Int |
Instances
newCreateDatasetResponse Source #
Create a value of CreateDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDatasetResponse, createDatasetResponse_datasetId - The unique identifier for the created Dataset.
$sel:httpStatus:CreateDatasetResponse', createDatasetResponse_httpStatus - The response's http status code.
CreatePermissionGroup
data CreatePermissionGroup Source #
See: newCreatePermissionGroup smart constructor.
Constructors
| CreatePermissionGroup' (Maybe Text) (Maybe (Sensitive Text)) (Sensitive Text) [ApplicationPermission] |
Instances
newCreatePermissionGroup Source #
Arguments
| :: Text | |
| -> CreatePermissionGroup |
Create a value of CreatePermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreatePermissionGroup', createPermissionGroup_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
CreatePermissionGroup, createPermissionGroup_description - A brief description for the permission group.
CreatePermissionGroup, createPermissionGroup_name - The name of the permission group.
CreatePermissionGroup, createPermissionGroup_applicationPermissions - 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.
data CreatePermissionGroupResponse Source #
See: newCreatePermissionGroupResponse smart constructor.
Constructors
| CreatePermissionGroupResponse' (Maybe Text) Int |
Instances
newCreatePermissionGroupResponse Source #
Create a value of CreatePermissionGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreatePermissionGroupResponse, createPermissionGroupResponse_permissionGroupId - The unique identifier for the permission group.
$sel:httpStatus:CreatePermissionGroupResponse', createPermissionGroupResponse_httpStatus - The response's http status code.
CreateUser
data CreateUser Source #
See: newCreateUser smart constructor.
Constructors
| CreateUser' (Maybe ApiAccess) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Sensitive Text) UserType |
Instances
Arguments
| :: Text | |
| -> UserType | |
| -> CreateUser |
Create a value of CreateUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUser, createUser_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.
CreateUser, createUser_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.
$sel:clientToken:CreateUser', createUser_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
CreateUser, createUser_firstName - The first name of the user that you want to register.
CreateUser, createUser_lastName - The last name of the user that you want to register.
CreateUser, createUser_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.
CreateUser, createUser_type - 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.
data CreateUserResponse Source #
See: newCreateUserResponse smart constructor.
Constructors
| CreateUserResponse' (Maybe Text) Int |
Instances
newCreateUserResponse Source #
Arguments
| :: Int | |
| -> CreateUserResponse |
Create a value of CreateUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUserResponse, createUserResponse_userId - The unique identifier for the user.
$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.
DeleteDataset
data DeleteDataset Source #
The request for a DeleteDataset operation.
See: newDeleteDataset smart constructor.
Constructors
| DeleteDataset' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DeleteDataset |
Create a value of DeleteDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeleteDataset', deleteDataset_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
DeleteDataset, deleteDataset_datasetId - The unique identifier of the Dataset to be deleted.
data DeleteDatasetResponse Source #
The response from an DeleteDataset operation
See: newDeleteDatasetResponse smart constructor.
Constructors
| DeleteDatasetResponse' (Maybe Text) Int |
Instances
newDeleteDatasetResponse Source #
Create a value of DeleteDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteDataset, deleteDatasetResponse_datasetId - The unique identifier for the deleted Dataset.
$sel:httpStatus:DeleteDatasetResponse', deleteDatasetResponse_httpStatus - The response's http status code.
DeletePermissionGroup
data DeletePermissionGroup Source #
See: newDeletePermissionGroup smart constructor.
Constructors
| DeletePermissionGroup' (Maybe Text) Text |
Instances
newDeletePermissionGroup Source #
Arguments
| :: Text | |
| -> DeletePermissionGroup |
Create a value of DeletePermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DeletePermissionGroup', deletePermissionGroup_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
DeletePermissionGroup, deletePermissionGroup_permissionGroupId - The unique identifier for the permission group that you want to delete.
data DeletePermissionGroupResponse Source #
See: newDeletePermissionGroupResponse smart constructor.
Constructors
| DeletePermissionGroupResponse' (Maybe Text) Int |
Instances
newDeletePermissionGroupResponse Source #
Create a value of DeletePermissionGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeletePermissionGroup, deletePermissionGroupResponse_permissionGroupId - The unique identifier for the deleted permission group.
$sel:httpStatus:DeletePermissionGroupResponse', deletePermissionGroupResponse_httpStatus - The response's http status code.
DisableUser
data DisableUser Source #
See: newDisableUser smart constructor.
Constructors
| DisableUser' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> DisableUser |
Create a value of DisableUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DisableUser', disableUser_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
DisableUser, disableUser_userId - The unique identifier for the user account that you want to disable.
data DisableUserResponse Source #
See: newDisableUserResponse smart constructor.
Constructors
| DisableUserResponse' (Maybe Text) Int |
Instances
newDisableUserResponse Source #
Arguments
| :: Int | |
| -> DisableUserResponse |
Create a value of DisableUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisableUser, disableUserResponse_userId - The unique identifier for the disabled user account.
$sel:httpStatus:DisableUserResponse', disableUserResponse_httpStatus - The response's http status code.
DisassociateUserFromPermissionGroup
data DisassociateUserFromPermissionGroup Source #
See: newDisassociateUserFromPermissionGroup smart constructor.
Constructors
| DisassociateUserFromPermissionGroup' (Maybe Text) Text Text |
Instances
newDisassociateUserFromPermissionGroup Source #
Arguments
| :: Text | |
| -> Text | |
| -> DisassociateUserFromPermissionGroup |
Create a value of DisassociateUserFromPermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:DisassociateUserFromPermissionGroup', disassociateUserFromPermissionGroup_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
DisassociateUserFromPermissionGroup, disassociateUserFromPermissionGroup_permissionGroupId - The unique identifier for the permission group.
DisassociateUserFromPermissionGroup, disassociateUserFromPermissionGroup_userId - The unique identifier for the user.
data DisassociateUserFromPermissionGroupResponse Source #
See: newDisassociateUserFromPermissionGroupResponse smart constructor.
Constructors
| DisassociateUserFromPermissionGroupResponse' Int |
Instances
newDisassociateUserFromPermissionGroupResponse Source #
Arguments
| :: Int |
|
| -> DisassociateUserFromPermissionGroupResponse |
Create a value of DisassociateUserFromPermissionGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:statusCode:DisassociateUserFromPermissionGroupResponse', disassociateUserFromPermissionGroupResponse_statusCode - The returned status code of the response.
EnableUser
data EnableUser Source #
See: newEnableUser smart constructor.
Constructors
| EnableUser' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> EnableUser |
Create a value of EnableUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:EnableUser', enableUser_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
EnableUser, enableUser_userId - The unique identifier for the user account that you want to enable.
data EnableUserResponse Source #
See: newEnableUserResponse smart constructor.
Constructors
| EnableUserResponse' (Maybe Text) Int |
Instances
newEnableUserResponse Source #
Arguments
| :: Int | |
| -> EnableUserResponse |
Create a value of EnableUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
EnableUser, enableUserResponse_userId - The unique identifier for the enabled user account.
$sel:httpStatus:EnableUserResponse', enableUserResponse_httpStatus - The response's http status code.
GetChangeset
data GetChangeset Source #
Request to describe a changeset.
See: newGetChangeset smart constructor.
Constructors
| GetChangeset' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetChangeset |
Create a value of GetChangeset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChangeset, getChangeset_datasetId - The unique identifier for the FinSpace Dataset where the Changeset is
created.
GetChangeset, getChangeset_changesetId - The unique identifier of the Changeset for which to get data.
data GetChangesetResponse Source #
The response from a describe changeset operation
See: newGetChangesetResponse smart constructor.
Constructors
| GetChangesetResponse' (Maybe Integer) (Maybe Integer) (Maybe ChangeType) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe ChangesetErrorInfo) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe IngestionStatus) (Maybe Text) (Maybe Text) Int |
Instances
newGetChangesetResponse Source #
Arguments
| :: Int | |
| -> GetChangesetResponse |
Create a value of GetChangesetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetChangesetResponse, 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.
GetChangesetResponse, 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, getChangesetResponse_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.
GetChangesetResponse, getChangesetResponse_changesetArn - The ARN identifier of the Changeset.
GetChangeset, getChangesetResponse_changesetId - The unique identifier for a Changeset.
GetChangesetResponse, 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.
GetChangeset, getChangesetResponse_datasetId - The unique identifier for the FinSpace Dataset where the Changeset is
created.
GetChangesetResponse, getChangesetResponse_errorInfo - The structure with error messages.
GetChangesetResponse, getChangesetResponse_formatParams - Structure of the source file(s).
GetChangesetResponse, getChangesetResponse_sourceParams - Options that define the location of the data being ingested.
GetChangesetResponse, getChangesetResponse_status - The status of Changeset creation operation.
GetChangesetResponse, getChangesetResponse_updatedByChangesetId - The unique identifier of the updated Changeset.
GetChangesetResponse, getChangesetResponse_updatesChangesetId - The unique identifier of the Changeset that is being updated.
$sel:httpStatus:GetChangesetResponse', getChangesetResponse_httpStatus - The response's http status code.
GetDataView
data GetDataView Source #
Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.
See: newGetDataView smart constructor.
Constructors
| GetDataView' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> GetDataView |
Create a value of GetDataView with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDataView, getDataView_dataViewId - The unique identifier for the Dataview.
GetDataView, getDataView_datasetId - The unique identifier for the Dataset used in the Dataview.
data GetDataViewResponse Source #
Response from retrieving a dataview, which includes details on the target database and table name
See: newGetDataViewResponse smart constructor.
Constructors
| GetDataViewResponse' (Maybe Integer) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataViewDestinationTypeParams) (Maybe DataViewErrorInfo) (Maybe Integer) (Maybe [Text]) (Maybe [Text]) (Maybe DataViewStatus) Int |
Instances
newGetDataViewResponse Source #
Arguments
| :: Int | |
| -> GetDataViewResponse |
Create a value of GetDataViewResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDataViewResponse, 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, getDataViewResponse_autoUpdate - Flag to indicate Dataview should be updated automatically.
GetDataViewResponse, 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.
GetDataViewResponse, getDataViewResponse_dataViewArn - The ARN identifier of the Dataview.
GetDataView, getDataViewResponse_dataViewId - The unique identifier for the Dataview.
GetDataView, getDataViewResponse_datasetId - The unique identifier for the Dataset used in the Dataview.
$sel:destinationTypeParams:GetDataViewResponse', getDataViewResponse_destinationTypeParams - Options that define the destination type for the Dataview.
GetDataViewResponse, getDataViewResponse_errorInfo - Information about an error that occurred for the Dataview.
GetDataViewResponse, 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, getDataViewResponse_partitionColumns - Ordered set of column names used to partition data.
GetDataViewResponse, getDataViewResponse_sortColumns - Columns to be used for sorting the data.
GetDataViewResponse, getDataViewResponse_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.
$sel:httpStatus:GetDataViewResponse', getDataViewResponse_httpStatus - The response's http status code.
GetDataset
data GetDataset Source #
Request for the GetDataset operation.
See: newGetDataset smart constructor.
Constructors
| GetDataset' Text |
Instances
Arguments
| :: Text | |
| -> GetDataset |
Create a value of GetDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDataset, getDataset_datasetId - The unique identifier for a Dataset.
data GetDatasetResponse Source #
Response for the GetDataset operation
See: newGetDatasetResponse smart constructor.
Constructors
| GetDatasetResponse' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetKind) (Maybe Integer) (Maybe SchemaUnion) (Maybe DatasetStatus) Int |
Instances
newGetDatasetResponse Source #
Arguments
| :: Int | |
| -> GetDatasetResponse |
Create a value of GetDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetDatasetResponse, getDatasetResponse_alias - The unique resource identifier for a Dataset.
GetDatasetResponse, 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, getDatasetResponse_datasetArn - The ARN identifier of the Dataset.
GetDatasetResponse, getDatasetResponse_datasetDescription - A description of the Dataset.
GetDataset, getDatasetResponse_datasetId - The unique identifier for a Dataset.
GetDatasetResponse, getDatasetResponse_datasetTitle - Display title for a Dataset.
GetDatasetResponse, getDatasetResponse_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.
GetDatasetResponse, 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.
GetDatasetResponse, getDatasetResponse_schemaDefinition - Definition for a schema on a tabular Dataset.
GetDatasetResponse, 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.
$sel:httpStatus:GetDatasetResponse', getDatasetResponse_httpStatus - The response's http status code.
GetExternalDataViewAccessDetails
data GetExternalDataViewAccessDetails Source #
See: newGetExternalDataViewAccessDetails smart constructor.
Constructors
| GetExternalDataViewAccessDetails' Text Text |
Instances
newGetExternalDataViewAccessDetails Source #
Arguments
| :: Text | |
| -> Text | |
| -> GetExternalDataViewAccessDetails |
Create a value of GetExternalDataViewAccessDetails with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetExternalDataViewAccessDetails, getExternalDataViewAccessDetails_dataViewId - The unique identifier for the Dataview that you want to access.
GetExternalDataViewAccessDetails, getExternalDataViewAccessDetails_datasetId - The unique identifier for the Dataset.
data GetExternalDataViewAccessDetailsResponse Source #
See: newGetExternalDataViewAccessDetailsResponse smart constructor.
Constructors
| GetExternalDataViewAccessDetailsResponse' (Maybe AwsCredentials) (Maybe S3Location) Int |
Instances
newGetExternalDataViewAccessDetailsResponse Source #
Arguments
| :: Int | |
| -> GetExternalDataViewAccessDetailsResponse |
Create a value of GetExternalDataViewAccessDetailsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:credentials:GetExternalDataViewAccessDetailsResponse', getExternalDataViewAccessDetailsResponse_credentials - The credentials required to access the external Dataview from the S3
location.
$sel:s3Location:GetExternalDataViewAccessDetailsResponse', getExternalDataViewAccessDetailsResponse_s3Location - The location where the external Dataview is stored.
$sel:httpStatus:GetExternalDataViewAccessDetailsResponse', getExternalDataViewAccessDetailsResponse_httpStatus - The response's http status code.
GetPermissionGroup
data GetPermissionGroup Source #
See: newGetPermissionGroup smart constructor.
Constructors
| GetPermissionGroup' Text |
Instances
newGetPermissionGroup Source #
Arguments
| :: Text | |
| -> GetPermissionGroup |
Create a value of GetPermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetPermissionGroup, getPermissionGroup_permissionGroupId - The unique identifier for the permission group.
data GetPermissionGroupResponse Source #
See: newGetPermissionGroupResponse smart constructor.
Constructors
| GetPermissionGroupResponse' (Maybe PermissionGroup) Int |
Instances
newGetPermissionGroupResponse Source #
Create a value of GetPermissionGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:permissionGroup:GetPermissionGroupResponse', getPermissionGroupResponse_permissionGroup - Undocumented member.
$sel:httpStatus:GetPermissionGroupResponse', getPermissionGroupResponse_httpStatus - The response's http status code.
GetProgrammaticAccessCredentials
data GetProgrammaticAccessCredentials Source #
Request for GetProgrammaticAccessCredentials operation
See: newGetProgrammaticAccessCredentials smart constructor.
Constructors
| GetProgrammaticAccessCredentials' (Maybe Natural) Text |
Instances
newGetProgrammaticAccessCredentials Source #
Arguments
| :: Text | |
| -> GetProgrammaticAccessCredentials |
Create a value of GetProgrammaticAccessCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetProgrammaticAccessCredentials, getProgrammaticAccessCredentials_durationInMinutes - The time duration in which the credentials remain valid.
$sel:environmentId:GetProgrammaticAccessCredentials', getProgrammaticAccessCredentials_environmentId - The FinSpace environment identifier.
data GetProgrammaticAccessCredentialsResponse Source #
Response for GetProgrammaticAccessCredentials operation
See: newGetProgrammaticAccessCredentialsResponse smart constructor.
Constructors
| GetProgrammaticAccessCredentialsResponse' (Maybe Credentials) (Maybe Natural) Int |
Instances
newGetProgrammaticAccessCredentialsResponse Source #
Arguments
| :: Int | |
| -> GetProgrammaticAccessCredentialsResponse |
Create a value of GetProgrammaticAccessCredentialsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:credentials:GetProgrammaticAccessCredentialsResponse', getProgrammaticAccessCredentialsResponse_credentials - Returns the programmatic credentials.
GetProgrammaticAccessCredentials, getProgrammaticAccessCredentialsResponse_durationInMinutes - Returns the duration in which the credentials will remain valid.
$sel:httpStatus:GetProgrammaticAccessCredentialsResponse', getProgrammaticAccessCredentialsResponse_httpStatus - The response's http status code.
GetUser
See: newGetUser smart constructor.
Instances
Create a value of GetUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetUser, getUser_userId - The unique identifier of the user to get data for.
data GetUserResponse Source #
See: newGetUserResponse smart constructor.
Constructors
| GetUserResponse' (Maybe ApiAccess) (Maybe Text) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe UserStatus) (Maybe UserType) (Maybe Text) Int |
Instances
Arguments
| :: Int | |
| -> GetUserResponse |
Create a value of GetUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetUserResponse, getUserResponse_apiAccess - Indicates whether the user can use the
GetProgrammaticAccessCredentials API to obtain credentials that can
then be used to access other FinSpace Data API operations.
ENABLED– The user has permissions to use the APIs.DISABLED– The user does not have permissions to use any APIs.
GetUserResponse, getUserResponse_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.
GetUserResponse, getUserResponse_createTime - The timestamp at which the user account was created in FinSpace. The
value is determined as epoch time in milliseconds.
GetUserResponse, getUserResponse_emailAddress - The email address that is associated with the user.
GetUserResponse, getUserResponse_firstName - The first name of the user.
GetUserResponse, getUserResponse_lastDisabledTime - Describes the last time the user account was disabled. The value is
determined as epoch time in milliseconds.
GetUserResponse, getUserResponse_lastEnabledTime - Describes the last time the user account was enabled. The value is
determined as epoch time in milliseconds.
GetUserResponse, getUserResponse_lastLoginTime - Describes the last time that the user logged into their account. The
value is determined as epoch time in milliseconds.
GetUserResponse, getUserResponse_lastModifiedTime - Describes the last time the user account was updated. The value is
determined as epoch time in milliseconds.
GetUserResponse, getUserResponse_lastName - The last name of the user.
GetUserResponse, 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.
GetUserResponse, getUserResponse_type - 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.
GetUser, getUserResponse_userId - The unique identifier for the user account that is retrieved.
$sel:httpStatus:GetUserResponse', getUserResponse_httpStatus - The response's http status code.
GetWorkingLocation
data GetWorkingLocation Source #
See: newGetWorkingLocation smart constructor.
Constructors
| GetWorkingLocation' (Maybe LocationType) |
Instances
newGetWorkingLocation :: GetWorkingLocation Source #
Create a value of GetWorkingLocation with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:locationType:GetWorkingLocation', getWorkingLocation_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.
data GetWorkingLocationResponse Source #
See: newGetWorkingLocationResponse smart constructor.
Instances
newGetWorkingLocationResponse Source #
Create a value of GetWorkingLocationResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3Bucket:GetWorkingLocationResponse', getWorkingLocationResponse_s3Bucket - Returns the Amazon S3 bucket name for the working location.
$sel:s3Path:GetWorkingLocationResponse', getWorkingLocationResponse_s3Path - Returns the Amazon S3 Path for the working location.
$sel:s3Uri:GetWorkingLocationResponse', getWorkingLocationResponse_s3Uri - Returns the Amazon S3 URI for the working location.
$sel:httpStatus:GetWorkingLocationResponse', getWorkingLocationResponse_httpStatus - The response's http status code.
ListChangesets (Paginated)
data ListChangesets Source #
Request to ListChangesetsRequest. It exposes minimal query filters.
See: newListChangesets smart constructor.
Instances
Arguments
| :: Text | |
| -> ListChangesets |
Create a value of ListChangesets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListChangesets', listChangesets_maxResults - The maximum number of results per page.
ListChangesets, listChangesets_nextToken - A token that indicates where a results page should begin.
ListChangesets, listChangesets_datasetId - The unique identifier for the FinSpace Dataset to which the Changeset
belongs.
data ListChangesetsResponse Source #
Response to ListChangesetsResponse. This returns a list of dataset changesets that match the query criteria.
See: newListChangesetsResponse smart constructor.
Constructors
| ListChangesetsResponse' (Maybe [ChangesetSummary]) (Maybe Text) Int |
Instances
newListChangesetsResponse Source #
Create a value of ListChangesetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:changesets:ListChangesetsResponse', listChangesetsResponse_changesets - List of Changesets found.
ListChangesets, listChangesetsResponse_nextToken - A token that indicates where a results page should begin.
$sel:httpStatus:ListChangesetsResponse', listChangesetsResponse_httpStatus - The response's http status code.
ListDataViews (Paginated)
data ListDataViews Source #
Request for a list data views.
See: newListDataViews smart constructor.
Instances
Arguments
| :: Text | |
| -> ListDataViews |
Create a value of ListDataViews with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDataViews', listDataViews_maxResults - The maximum number of results per page.
ListDataViews, listDataViews_nextToken - A token that indicates where a results page should begin.
ListDataViews, listDataViews_datasetId - The unique identifier of the Dataset for which to retrieve Dataviews.
data ListDataViewsResponse Source #
See: newListDataViewsResponse smart constructor.
Constructors
| ListDataViewsResponse' (Maybe [DataViewSummary]) (Maybe Text) Int |
Instances
newListDataViewsResponse Source #
Create a value of ListDataViewsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:dataViews:ListDataViewsResponse', listDataViewsResponse_dataViews - A list of Dataviews.
ListDataViews, listDataViewsResponse_nextToken - A token that indicates where a results page should begin.
$sel:httpStatus:ListDataViewsResponse', listDataViewsResponse_httpStatus - The response's http status code.
ListDatasets (Paginated)
data ListDatasets Source #
Request for the ListDatasets operation.
See: newListDatasets smart constructor.
Constructors
| ListDatasets' (Maybe Natural) (Maybe Text) |
Instances
newListDatasets :: ListDatasets Source #
Create a value of ListDatasets with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListDatasets', listDatasets_maxResults - The maximum number of results per page.
ListDatasets, listDatasets_nextToken - A token that indicates where a results page should begin.
data ListDatasetsResponse Source #
Response for the ListDatasets operation
See: newListDatasetsResponse smart constructor.
Instances
newListDatasetsResponse Source #
Arguments
| :: Int | |
| -> ListDatasetsResponse |
Create a value of ListDatasetsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasets:ListDatasetsResponse', listDatasetsResponse_datasets - List of Datasets.
ListDatasets, listDatasetsResponse_nextToken - A token that indicates where a results page should begin.
$sel:httpStatus:ListDatasetsResponse', listDatasetsResponse_httpStatus - The response's http status code.
ListPermissionGroups (Paginated)
data ListPermissionGroups Source #
See: newListPermissionGroups smart constructor.
Constructors
| ListPermissionGroups' (Maybe Text) Natural |
Instances
newListPermissionGroups Source #
Create a value of ListPermissionGroups with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPermissionGroups, listPermissionGroups_nextToken - A token that indicates where a results page should begin.
$sel:maxResults:ListPermissionGroups', listPermissionGroups_maxResults - The maximum number of results per page.
data ListPermissionGroupsResponse Source #
See: newListPermissionGroupsResponse smart constructor.
Constructors
| ListPermissionGroupsResponse' (Maybe Text) (Maybe [PermissionGroup]) Int |
Instances
newListPermissionGroupsResponse Source #
Create a value of ListPermissionGroupsResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPermissionGroups, listPermissionGroupsResponse_nextToken - A token that indicates where a results page should begin.
$sel:permissionGroups:ListPermissionGroupsResponse', listPermissionGroupsResponse_permissionGroups - A list of all the permission groups.
$sel:httpStatus:ListPermissionGroupsResponse', listPermissionGroupsResponse_httpStatus - The response's http status code.
ListPermissionGroupsByUser
data ListPermissionGroupsByUser Source #
See: newListPermissionGroupsByUser smart constructor.
Constructors
| ListPermissionGroupsByUser' (Maybe Text) Text Natural |
Instances
newListPermissionGroupsByUser Source #
Arguments
| :: Text | |
| -> Natural | |
| -> ListPermissionGroupsByUser |
Create a value of ListPermissionGroupsByUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPermissionGroupsByUser, listPermissionGroupsByUser_nextToken - A token that indicates where a results page should begin.
ListPermissionGroupsByUser, listPermissionGroupsByUser_userId - The unique identifier for the user.
$sel:maxResults:ListPermissionGroupsByUser', listPermissionGroupsByUser_maxResults - The maximum number of results per page.
data ListPermissionGroupsByUserResponse Source #
See: newListPermissionGroupsByUserResponse smart constructor.
Constructors
| ListPermissionGroupsByUserResponse' (Maybe Text) (Maybe [PermissionGroupByUser]) Int |
Instances
newListPermissionGroupsByUserResponse Source #
Arguments
| :: Int | |
| -> ListPermissionGroupsByUserResponse |
Create a value of ListPermissionGroupsByUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListPermissionGroupsByUser, listPermissionGroupsByUserResponse_nextToken - A token that indicates where a results page should begin.
$sel:permissionGroups:ListPermissionGroupsByUserResponse', listPermissionGroupsByUserResponse_permissionGroups - A list of returned permission groups.
$sel:httpStatus:ListPermissionGroupsByUserResponse', listPermissionGroupsByUserResponse_httpStatus - The response's http status code.
ListUsers (Paginated)
See: newListUsers smart constructor.
Constructors
| ListUsers' (Maybe Text) Natural |
Instances
Create a value of ListUsers with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUsers, listUsers_nextToken - A token that indicates where a results page should begin.
$sel:maxResults:ListUsers', listUsers_maxResults - The maximum number of results per page.
data ListUsersResponse Source #
See: newListUsersResponse smart constructor.
Instances
Arguments
| :: Int | |
| -> ListUsersResponse |
Create a value of ListUsersResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUsers, listUsersResponse_nextToken - A token that indicates where a results page should begin.
$sel:users:ListUsersResponse', listUsersResponse_users - A list of all the user accounts.
$sel:httpStatus:ListUsersResponse', listUsersResponse_httpStatus - The response's http status code.
ListUsersByPermissionGroup
data ListUsersByPermissionGroup Source #
See: newListUsersByPermissionGroup smart constructor.
Constructors
| ListUsersByPermissionGroup' (Maybe Text) Text Natural |
Instances
newListUsersByPermissionGroup Source #
Arguments
| :: Text | |
| -> Natural | |
| -> ListUsersByPermissionGroup |
Create a value of ListUsersByPermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUsersByPermissionGroup, listUsersByPermissionGroup_nextToken - A token that indicates where a results page should begin.
ListUsersByPermissionGroup, listUsersByPermissionGroup_permissionGroupId - The unique identifier for the permission group.
$sel:maxResults:ListUsersByPermissionGroup', listUsersByPermissionGroup_maxResults - The maximum number of results per page.
data ListUsersByPermissionGroupResponse Source #
See: newListUsersByPermissionGroupResponse smart constructor.
Constructors
| ListUsersByPermissionGroupResponse' (Maybe Text) (Maybe [UserByPermissionGroup]) Int |
Instances
newListUsersByPermissionGroupResponse Source #
Arguments
| :: Int | |
| -> ListUsersByPermissionGroupResponse |
Create a value of ListUsersByPermissionGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListUsersByPermissionGroup, listUsersByPermissionGroupResponse_nextToken - A token that indicates where a results page should begin.
$sel:users:ListUsersByPermissionGroupResponse', listUsersByPermissionGroupResponse_users - Lists details of all users in a specific permission group.
$sel:httpStatus:ListUsersByPermissionGroupResponse', listUsersByPermissionGroupResponse_httpStatus - The response's http status code.
ResetUserPassword
data ResetUserPassword Source #
See: newResetUserPassword smart constructor.
Constructors
| ResetUserPassword' (Maybe Text) Text |
Instances
Arguments
| :: Text | |
| -> ResetUserPassword |
Create a value of ResetUserPassword with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:ResetUserPassword', resetUserPassword_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
ResetUserPassword, resetUserPassword_userId - The unique identifier of the user that a temporary password is requested
for.
data ResetUserPasswordResponse Source #
See: newResetUserPasswordResponse smart constructor.
Instances
newResetUserPasswordResponse Source #
Create a value of ResetUserPasswordResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:temporaryPassword:ResetUserPasswordResponse', resetUserPasswordResponse_temporaryPassword - A randomly generated temporary password for the requested user account.
This password expires in 7 days.
ResetUserPassword, resetUserPasswordResponse_userId - The unique identifier of the user that a new password is generated for.
$sel:httpStatus:ResetUserPasswordResponse', resetUserPasswordResponse_httpStatus - The response's http status code.
UpdateChangeset
data UpdateChangeset Source #
Request to update an existing changeset.
See: newUpdateChangeset smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> UpdateChangeset |
Create a value of UpdateChangeset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:UpdateChangeset', updateChangeset_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
UpdateChangeset, updateChangeset_datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is
created.
UpdateChangeset, updateChangeset_changesetId - The unique identifier for the Changeset to update.
UpdateChangeset, updateChangeset_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.
UpdateChangeset, updateChangeset_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.
data UpdateChangesetResponse Source #
The response from a update changeset operation.
See: newUpdateChangesetResponse smart constructor.
Instances
newUpdateChangesetResponse Source #
Create a value of UpdateChangesetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateChangeset, updateChangesetResponse_changesetId - The unique identifier for the Changeset to update.
UpdateChangeset, updateChangesetResponse_datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is
created.
$sel:httpStatus:UpdateChangesetResponse', updateChangesetResponse_httpStatus - The response's http status code.
UpdateDataset
data UpdateDataset Source #
The request for an UpdateDataset operation
See: newUpdateDataset smart constructor.
Constructors
| UpdateDataset' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SchemaUnion) Text Text DatasetKind |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> DatasetKind | |
| -> UpdateDataset |
Create a value of UpdateDataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDataset, updateDataset_alias - The unique resource identifier for a Dataset.
$sel:clientToken:UpdateDataset', updateDataset_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
UpdateDataset, updateDataset_datasetDescription - A description for the Dataset.
UpdateDataset, updateDataset_schemaDefinition - Definition for a schema on a tabular Dataset.
UpdateDataset, updateDataset_datasetId - The unique identifier for the Dataset to update.
UpdateDataset, updateDataset_datasetTitle - A display title for the Dataset.
UpdateDataset, updateDataset_kind - 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.
data UpdateDatasetResponse Source #
The response from an UpdateDataset operation
See: newUpdateDatasetResponse smart constructor.
Constructors
| UpdateDatasetResponse' (Maybe Text) Int |
Instances
newUpdateDatasetResponse Source #
Create a value of UpdateDatasetResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateDataset, updateDatasetResponse_datasetId - The unique identifier for updated Dataset.
$sel:httpStatus:UpdateDatasetResponse', updateDatasetResponse_httpStatus - The response's http status code.
UpdatePermissionGroup
data UpdatePermissionGroup Source #
See: newUpdatePermissionGroup smart constructor.
Constructors
| UpdatePermissionGroup' (Maybe [ApplicationPermission]) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) Text |
Instances
newUpdatePermissionGroup Source #
Arguments
| :: Text | |
| -> UpdatePermissionGroup |
Create a value of UpdatePermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdatePermissionGroup, updatePermissionGroup_applicationPermissions - 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.
$sel:clientToken:UpdatePermissionGroup', updatePermissionGroup_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
UpdatePermissionGroup, updatePermissionGroup_description - A brief description for the permission group.
UpdatePermissionGroup, updatePermissionGroup_name - The name of the permission group.
UpdatePermissionGroup, updatePermissionGroup_permissionGroupId - The unique identifier for the permission group to update.
data UpdatePermissionGroupResponse Source #
See: newUpdatePermissionGroupResponse smart constructor.
Constructors
| UpdatePermissionGroupResponse' (Maybe Text) Int |
Instances
newUpdatePermissionGroupResponse Source #
Create a value of UpdatePermissionGroupResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdatePermissionGroup, updatePermissionGroupResponse_permissionGroupId - The unique identifier for the updated permission group.
$sel:httpStatus:UpdatePermissionGroupResponse', updatePermissionGroupResponse_httpStatus - The response's http status code.
UpdateUser
data UpdateUser Source #
See: newUpdateUser smart constructor.
Constructors
| UpdateUser' (Maybe ApiAccess) (Maybe Text) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe UserType) Text |
Instances
Arguments
| :: Text | |
| -> UpdateUser |
Create a value of UpdateUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUser, updateUser_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.
UpdateUser, updateUser_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.
$sel:clientToken:UpdateUser', updateUser_clientToken - A token that ensures idempotency. This token expires in 10 minutes.
UpdateUser, updateUser_firstName - The first name of the user.
UpdateUser, updateUser_lastName - The last name of the user.
UpdateUser, updateUser_type - 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, updateUser_userId - The unique identifier for the user account to update.
data UpdateUserResponse Source #
See: newUpdateUserResponse smart constructor.
Constructors
| UpdateUserResponse' (Maybe Text) Int |
Instances
newUpdateUserResponse Source #
Arguments
| :: Int | |
| -> UpdateUserResponse |
Create a value of UpdateUserResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUser, updateUserResponse_userId - The unique identifier of the updated user account.
$sel:httpStatus:UpdateUserResponse', updateUserResponse_httpStatus - The response's http status code.
Types
ApiAccess
Constructors
| ApiAccess' | |
Fields | |
Bundled Patterns
| pattern ApiAccess_DISABLED :: ApiAccess | |
| pattern ApiAccess_ENABLED :: ApiAccess |
Instances
ApplicationPermission
newtype ApplicationPermission Source #
Constructors
| ApplicationPermission' | |
Fields | |
Bundled Patterns
Instances
ChangeType
newtype ChangeType Source #
Indicates how the given change will be applied to the dataset.
Constructors
| ChangeType' | |
Fields | |
Bundled Patterns
| pattern ChangeType_APPEND :: ChangeType | |
| pattern ChangeType_MODIFY :: ChangeType | |
| pattern ChangeType_REPLACE :: ChangeType |
Instances
ColumnDataType
newtype ColumnDataType Source #
Data type of a column.
Constructors
| ColumnDataType' | |
Fields | |
Bundled Patterns
| pattern ColumnDataType_BIGINT :: ColumnDataType | |
| pattern ColumnDataType_BINARY :: ColumnDataType | |
| pattern ColumnDataType_BOOLEAN :: ColumnDataType | |
| pattern ColumnDataType_CHAR :: ColumnDataType | |
| pattern ColumnDataType_DATE :: ColumnDataType | |
| pattern ColumnDataType_DATETIME :: ColumnDataType | |
| pattern ColumnDataType_DOUBLE :: ColumnDataType | |
| pattern ColumnDataType_FLOAT :: ColumnDataType | |
| pattern ColumnDataType_INTEGER :: ColumnDataType | |
| pattern ColumnDataType_SMALLINT :: ColumnDataType | |
| pattern ColumnDataType_STRING :: ColumnDataType | |
| pattern ColumnDataType_TINYINT :: ColumnDataType |
Instances
DataViewStatus
newtype DataViewStatus Source #
Status of a DataView
Constructors
| DataViewStatus' | |
Fields | |
Bundled Patterns
| pattern DataViewStatus_CANCELLED :: DataViewStatus | |
| pattern DataViewStatus_FAILED :: DataViewStatus | |
| pattern DataViewStatus_FAILED_CLEANUP_FAILED :: DataViewStatus | |
| pattern DataViewStatus_PENDING :: DataViewStatus | |
| pattern DataViewStatus_RUNNING :: DataViewStatus | |
| pattern DataViewStatus_STARTING :: DataViewStatus | |
| pattern DataViewStatus_SUCCESS :: DataViewStatus | |
| pattern DataViewStatus_TIMEOUT :: DataViewStatus |
Instances
DatasetKind
newtype DatasetKind Source #
Dataset Kind
Constructors
| DatasetKind' | |
Fields | |
Bundled Patterns
| pattern DatasetKind_NON_TABULAR :: DatasetKind | |
| pattern DatasetKind_TABULAR :: DatasetKind |
Instances
DatasetStatus
newtype DatasetStatus Source #
Status of the dataset process returned from scheduler service.
Constructors
| DatasetStatus' | |
Fields | |
Bundled Patterns
| pattern DatasetStatus_FAILED :: DatasetStatus | |
| pattern DatasetStatus_PENDING :: DatasetStatus | |
| pattern DatasetStatus_RUNNING :: DatasetStatus | |
| pattern DatasetStatus_SUCCESS :: DatasetStatus |
Instances
ErrorCategory
newtype ErrorCategory Source #
Changeset Error Category
Constructors
| ErrorCategory' | |
Fields | |
Bundled Patterns
| pattern ErrorCategory_ACCESS_DENIED :: ErrorCategory | |
| pattern ErrorCategory_CANCELLED :: ErrorCategory | |
| pattern ErrorCategory_INTERNAL_SERVICE_EXCEPTION :: ErrorCategory | |
| pattern ErrorCategory_RESOURCE_NOT_FOUND :: ErrorCategory | |
| pattern ErrorCategory_SERVICE_QUOTA_EXCEEDED :: ErrorCategory | |
| pattern ErrorCategory_THROTTLING :: ErrorCategory | |
| pattern ErrorCategory_USER_RECOVERABLE :: ErrorCategory | |
| pattern ErrorCategory_VALIDATION :: ErrorCategory |
Instances
ExportFileFormat
newtype ExportFileFormat Source #
Data View Export File Format
Constructors
| ExportFileFormat' | |
Fields | |
Bundled Patterns
| pattern ExportFileFormat_DELIMITED_TEXT :: ExportFileFormat | |
| pattern ExportFileFormat_PARQUET :: ExportFileFormat |
Instances
IngestionStatus
newtype IngestionStatus Source #
Status of the ingestion process returned from scheduler service.
Constructors
| IngestionStatus' | |
Fields | |
Bundled Patterns
| pattern IngestionStatus_FAILED :: IngestionStatus | |
| pattern IngestionStatus_PENDING :: IngestionStatus | |
| pattern IngestionStatus_RUNNING :: IngestionStatus | |
| pattern IngestionStatus_STOP_REQUESTED :: IngestionStatus | |
| pattern IngestionStatus_SUCCESS :: IngestionStatus |
Instances
LocationType
newtype LocationType Source #
Constructors
| LocationType' | |
Fields | |
Bundled Patterns
| pattern LocationType_INGESTION :: LocationType | |
| pattern LocationType_SAGEMAKER :: LocationType |
Instances
PermissionGroupMembershipStatus
newtype PermissionGroupMembershipStatus Source #
Constructors
| PermissionGroupMembershipStatus' | |
Fields | |
Bundled Patterns
Instances
UserStatus
newtype UserStatus Source #
Constructors
| UserStatus' | |
Fields | |
Bundled Patterns
| pattern UserStatus_CREATING :: UserStatus | |
| pattern UserStatus_DISABLED :: UserStatus | |
| pattern UserStatus_ENABLED :: UserStatus |
Instances
UserType
Constructors
| UserType' | |
Fields
| |
Bundled Patterns
| pattern UserType_APP_USER :: UserType | |
| pattern UserType_SUPER_USER :: UserType |
Instances
AwsCredentials
data AwsCredentials Source #
The credentials required to access the external Dataview from the S3 location.
See: newAwsCredentials smart constructor.
Constructors
| AwsCredentials' (Maybe Text) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) |
Instances
newAwsCredentials :: AwsCredentials Source #
Create a value of AwsCredentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKeyId:AwsCredentials', awsCredentials_accessKeyId - The unique identifier for the security credentials.
$sel:expiration:AwsCredentials', awsCredentials_expiration - The Epoch time when the current credentials expire.
$sel:secretAccessKey:AwsCredentials', awsCredentials_secretAccessKey - The secret access key that can be used to sign requests.
$sel:sessionToken:AwsCredentials', awsCredentials_sessionToken - The token that users must pass to use the credentials.
ChangesetErrorInfo
data ChangesetErrorInfo Source #
The structure with error messages.
See: newChangesetErrorInfo smart constructor.
Constructors
| ChangesetErrorInfo' (Maybe ErrorCategory) (Maybe Text) |
Instances
newChangesetErrorInfo :: ChangesetErrorInfo Source #
Create a value of ChangesetErrorInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCategory:ChangesetErrorInfo', 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.
$sel:errorMessage:ChangesetErrorInfo', changesetErrorInfo_errorMessage - The text of the error message.
ChangesetSummary
data ChangesetSummary Source #
A Changeset is unit of data in a Dataset.
See: newChangesetSummary smart constructor.
Constructors
| ChangesetSummary' (Maybe Integer) (Maybe Integer) (Maybe ChangeType) (Maybe Text) (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe ChangesetErrorInfo) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe IngestionStatus) (Maybe Text) (Maybe Text) |
Instances
newChangesetSummary :: ChangesetSummary Source #
Create a value of ChangesetSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:activeFromTimestamp:ChangesetSummary', 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.
$sel:activeUntilTimestamp:ChangesetSummary', 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.
$sel:changeType:ChangesetSummary', 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.
$sel:changesetArn:ChangesetSummary', changesetSummary_changesetArn - The ARN identifier of the Changeset.
$sel:changesetId:ChangesetSummary', changesetSummary_changesetId - The unique identifier for a Changeset.
$sel:createTime:ChangesetSummary', 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.
$sel:datasetId:ChangesetSummary', changesetSummary_datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is
created.
$sel:errorInfo:ChangesetSummary', changesetSummary_errorInfo - The structure with error messages.
$sel:formatParams:ChangesetSummary', changesetSummary_formatParams - Options that define the structure of the source file(s).
$sel:sourceParams:ChangesetSummary', changesetSummary_sourceParams - Options that define the location of the data being ingested.
$sel:status:ChangesetSummary', 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.
$sel:updatedByChangesetId:ChangesetSummary', changesetSummary_updatedByChangesetId - The unique identifier of the updated Changeset.
$sel:updatesChangesetId:ChangesetSummary', changesetSummary_updatesChangesetId - The unique identifier of the Changeset that is updated.
ColumnDefinition
data ColumnDefinition Source #
The definition of a column in a tabular Dataset.
See: newColumnDefinition smart constructor.
Constructors
| ColumnDefinition' (Maybe Text) (Maybe Text) (Maybe ColumnDataType) |
Instances
newColumnDefinition :: ColumnDefinition Source #
Create a value of ColumnDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columnDescription:ColumnDefinition', columnDefinition_columnDescription - Description for a column.
$sel:columnName:ColumnDefinition', columnDefinition_columnName - The name of a column.
$sel:dataType:ColumnDefinition', 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.
Credentials
data Credentials Source #
Short term API credentials.
See: newCredentials smart constructor.
Instances
newCredentials :: Credentials Source #
Create a value of Credentials with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:accessKeyId:Credentials', credentials_accessKeyId - The access key identifier.
$sel:secretAccessKey:Credentials', credentials_secretAccessKey - The access key.
$sel:sessionToken:Credentials', credentials_sessionToken - The session token.
DataViewDestinationTypeParams
data DataViewDestinationTypeParams Source #
Structure for the Dataview destination type parameters.
See: newDataViewDestinationTypeParams smart constructor.
Constructors
| DataViewDestinationTypeParams' (Maybe ExportFileFormat) (Maybe (HashMap Text Text)) Text |
Instances
newDataViewDestinationTypeParams Source #
Create a value of DataViewDestinationTypeParams with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:s3DestinationExportFileFormat:DataViewDestinationTypeParams', dataViewDestinationTypeParams_s3DestinationExportFileFormat - Dataview export file format.
PARQUET– Parquet export file format.DELIMITED_TEXT– Delimited text export file format.
$sel:s3DestinationExportFileFormatOptions:DataViewDestinationTypeParams', dataViewDestinationTypeParams_s3DestinationExportFileFormatOptions - Format Options for S3 Destination type.
Here is an example of how you could specify the
s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }$sel:destinationType:DataViewDestinationTypeParams', dataViewDestinationTypeParams_destinationType - Destination type for a Dataview.
GLUE_TABLE– Glue table destination type.S3– S3 destination type.
DataViewErrorInfo
data DataViewErrorInfo Source #
The structure with error messages.
See: newDataViewErrorInfo smart constructor.
Constructors
| DataViewErrorInfo' (Maybe ErrorCategory) (Maybe Text) |
Instances
newDataViewErrorInfo :: DataViewErrorInfo Source #
Create a value of DataViewErrorInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:errorCategory:DataViewErrorInfo', dataViewErrorInfo_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.
$sel:errorMessage:DataViewErrorInfo', dataViewErrorInfo_errorMessage - The text of the error message.
DataViewSummary
data DataViewSummary Source #
Structure for the summary of a Dataview.
See: newDataViewSummary smart constructor.
Constructors
| DataViewSummary' (Maybe Integer) (Maybe Bool) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DataViewDestinationTypeParams) (Maybe DataViewErrorInfo) (Maybe Integer) (Maybe [Text]) (Maybe [Text]) (Maybe DataViewStatus) |
Instances
newDataViewSummary :: DataViewSummary Source #
Create a value of DataViewSummary with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:asOfTimestamp:DataViewSummary', 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.
$sel:autoUpdate:DataViewSummary', dataViewSummary_autoUpdate - The flag to indicate Dataview should be updated automatically.
$sel:createTime:DataViewSummary', 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.
$sel:dataViewArn:DataViewSummary', dataViewSummary_dataViewArn - The ARN identifier of the Dataview.
$sel:dataViewId:DataViewSummary', dataViewSummary_dataViewId - The unique identifier for the Dataview.
$sel:datasetId:DataViewSummary', dataViewSummary_datasetId - Th unique identifier for the Dataview Dataset.
$sel:destinationTypeProperties:DataViewSummary', dataViewSummary_destinationTypeProperties - Information about the Dataview destination.
$sel:errorInfo:DataViewSummary', dataViewSummary_errorInfo - The structure with error messages.
$sel:lastModifiedTime:DataViewSummary', 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.
$sel:partitionColumns:DataViewSummary', dataViewSummary_partitionColumns - Ordered set of column names used to partition data.
$sel:sortColumns:DataViewSummary', dataViewSummary_sortColumns - Columns to be used for sorting the data.
$sel:status:DataViewSummary', 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.
Dataset
The structure for a Dataset.
See: newDataset smart constructor.
Constructors
| Dataset' (Maybe Text) (Maybe Integer) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe DatasetKind) (Maybe Integer) (Maybe DatasetOwnerInfo) (Maybe SchemaUnion) |
Instances
newDataset :: Dataset Source #
Create a value of Dataset with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alias:Dataset', dataset_alias - The unique resource identifier for a Dataset.
$sel:createTime:Dataset', 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.
$sel:datasetArn:Dataset', dataset_datasetArn - The ARN identifier of the Dataset.
$sel:datasetDescription:Dataset', dataset_datasetDescription - Description for a Dataset.
$sel:datasetId:Dataset', dataset_datasetId - An identifier for a Dataset.
$sel:datasetTitle:Dataset', dataset_datasetTitle - Display title for a Dataset.
$sel:kind:Dataset', dataset_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.
$sel:lastModifiedTime:Dataset', 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.
$sel:ownerInfo:Dataset', dataset_ownerInfo - Contact information for a Dataset owner.
$sel:schemaDefinition:Dataset', dataset_schemaDefinition - Definition for a schema on a tabular Dataset.
DatasetOwnerInfo
data DatasetOwnerInfo Source #
A structure for Dataset owner info.
See: newDatasetOwnerInfo smart constructor.
Instances
newDatasetOwnerInfo :: DatasetOwnerInfo Source #
Create a value of DatasetOwnerInfo with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:email:DatasetOwnerInfo', datasetOwnerInfo_email - Email address for the Dataset owner.
$sel:name:DatasetOwnerInfo', datasetOwnerInfo_name - The name of the Dataset owner.
$sel:phoneNumber:DatasetOwnerInfo', datasetOwnerInfo_phoneNumber - Phone number for the Dataset owner.
PermissionGroup
data PermissionGroup Source #
The structure for a permission group.
See: newPermissionGroup smart constructor.
Constructors
| PermissionGroup' (Maybe [ApplicationPermission]) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe PermissionGroupMembershipStatus) (Maybe (Sensitive Text)) (Maybe Text) |
Instances
newPermissionGroup :: PermissionGroup Source #
Create a value of PermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:applicationPermissions:PermissionGroup', permissionGroup_applicationPermissions - 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.
$sel:createTime:PermissionGroup', permissionGroup_createTime - The timestamp at which the group was created in FinSpace. The value is
determined as epoch time in milliseconds.
$sel:description:PermissionGroup', permissionGroup_description - A brief description for the permission group.
$sel:lastModifiedTime:PermissionGroup', permissionGroup_lastModifiedTime - Describes the last time the permission group was updated. The value is
determined as epoch time in milliseconds.
$sel:membershipStatus:PermissionGroup', 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.
$sel:name:PermissionGroup', permissionGroup_name - The name of the permission group.
$sel:permissionGroupId:PermissionGroup', permissionGroup_permissionGroupId - The unique identifier for the permission group.
PermissionGroupByUser
data PermissionGroupByUser Source #
The structure of a permission group associated with a user account.
See: newPermissionGroupByUser smart constructor.
Constructors
| PermissionGroupByUser' (Maybe PermissionGroupMembershipStatus) (Maybe (Sensitive Text)) (Maybe Text) |
Instances
newPermissionGroupByUser :: PermissionGroupByUser Source #
Create a value of PermissionGroupByUser with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:membershipStatus:PermissionGroupByUser', permissionGroupByUser_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.
$sel:name:PermissionGroupByUser', permissionGroupByUser_name - The name of the permission group.
$sel:permissionGroupId:PermissionGroupByUser', permissionGroupByUser_permissionGroupId - The unique identifier for the permission group.
PermissionGroupParams
data PermissionGroupParams Source #
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"} ] }See: newPermissionGroupParams smart constructor.
Constructors
| PermissionGroupParams' (Maybe [ResourcePermission]) (Maybe Text) |
Instances
newPermissionGroupParams :: PermissionGroupParams Source #
Create a value of PermissionGroupParams with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:datasetPermissions:PermissionGroupParams', permissionGroupParams_datasetPermissions - List of resource permissions.
$sel:permissionGroupId:PermissionGroupParams', permissionGroupParams_permissionGroupId - The unique identifier for the PermissionGroup.
ResourcePermission
data ResourcePermission Source #
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.
See: newResourcePermission smart constructor.
Constructors
| ResourcePermission' (Maybe Text) |
Instances
newResourcePermission :: ResourcePermission Source #
Create a value of ResourcePermission with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:permission:ResourcePermission', resourcePermission_permission - Permission for a resource.
S3Location
data S3Location Source #
The location of an external Dataview in an S3 bucket.
See: newS3Location smart constructor.
Constructors
| S3Location' Text Text |
Instances
Arguments
| :: Text | |
| -> Text | |
| -> S3Location |
Create a value of S3Location with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:bucket:S3Location', s3Location_bucket - The name of the S3 bucket.
$sel:key:S3Location', s3Location_key - The path of the folder, within the S3 bucket that contains the Dataset.
SchemaDefinition
data SchemaDefinition Source #
Definition for a schema on a tabular Dataset.
See: newSchemaDefinition smart constructor.
Constructors
| SchemaDefinition' (Maybe [ColumnDefinition]) (Maybe [Text]) |
Instances
newSchemaDefinition :: SchemaDefinition Source #
Create a value of SchemaDefinition with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:columns:SchemaDefinition', schemaDefinition_columns - List of column definitions.
$sel:primaryKeyColumns:SchemaDefinition', schemaDefinition_primaryKeyColumns - List of column names used for primary key.
SchemaUnion
data SchemaUnion Source #
A union of schema types.
See: newSchemaUnion smart constructor.
Constructors
| SchemaUnion' (Maybe SchemaDefinition) |
Instances
newSchemaUnion :: SchemaUnion Source #
Create a value of SchemaUnion with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:tabularSchemaConfig:SchemaUnion', schemaUnion_tabularSchemaConfig - The configuration for a schema on a tabular Dataset.
User
The details of the user account.
See: newUser smart constructor.
Constructors
| User' (Maybe ApiAccess) (Maybe Text) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe Integer) (Maybe (Sensitive Text)) (Maybe UserStatus) (Maybe UserType) (Maybe Text) |
Instances
Create a value of User with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiAccess:User', user_apiAccess - Indicates whether the user can use the
GetProgrammaticAccessCredentials API to obtain credentials that can
then be used to access other FinSpace Data API operations.
ENABLED– The user has permissions to use the APIs.DISABLED– The user does not have permissions to use any APIs.
$sel:apiAccessPrincipalArn:User', user_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.
$sel:createTime:User', user_createTime - The timestamp at which the user account was created in FinSpace. The
value is determined as epoch time in milliseconds.
$sel:emailAddress: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.
$sel:firstName:User', user_firstName - The first name of the user.
$sel:lastDisabledTime:User', user_lastDisabledTime - Describes the last time the user account was disabled. The value is
determined as epoch time in milliseconds.
$sel:lastEnabledTime:User', user_lastEnabledTime - Describes the last time the user account was enabled. The value is
determined as epoch time in milliseconds.
$sel:lastLoginTime:User', user_lastLoginTime - Describes the last time that the user logged into their account. The
value is determined as epoch time in milliseconds.
$sel:lastModifiedTime:User', user_lastModifiedTime - Describes the last time the user account was updated. The value is
determined as epoch time in milliseconds.
$sel:lastName:User', user_lastName - The last name of the user.
$sel:status:User', user_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.
$sel:type':User', user_type - 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.
$sel:userId:User', user_userId - The unique identifier for the user.
UserByPermissionGroup
data UserByPermissionGroup Source #
The structure of a user account associated with a permission group.
See: newUserByPermissionGroup smart constructor.
Constructors
| UserByPermissionGroup' (Maybe ApiAccess) (Maybe Text) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe (Sensitive Text)) (Maybe PermissionGroupMembershipStatus) (Maybe UserStatus) (Maybe UserType) (Maybe Text) |
Instances
newUserByPermissionGroup :: UserByPermissionGroup Source #
Create a value of UserByPermissionGroup with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apiAccess:UserByPermissionGroup', userByPermissionGroup_apiAccess - 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.
$sel:apiAccessPrincipalArn:UserByPermissionGroup', userByPermissionGroup_apiAccessPrincipalArn - The IAM ARN identifier that is attached to FinSpace API calls.
$sel:emailAddress:UserByPermissionGroup', 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.
$sel:firstName:UserByPermissionGroup', userByPermissionGroup_firstName - The first name of the user.
$sel:lastName:UserByPermissionGroup', userByPermissionGroup_lastName - The last name of the user.
$sel:membershipStatus:UserByPermissionGroup', userByPermissionGroup_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.
$sel:status:UserByPermissionGroup', userByPermissionGroup_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.
$sel:type':UserByPermissionGroup', userByPermissionGroup_type - 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.
$sel:userId:UserByPermissionGroup', userByPermissionGroup_userId - The unique identifier for the user.