| 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.Types
Contents
- Service Configuration
- Errors
- 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
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
- 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' {}
- newAwsCredentials :: AwsCredentials
- awsCredentials_accessKeyId :: Lens' AwsCredentials (Maybe Text)
- awsCredentials_expiration :: Lens' AwsCredentials (Maybe Integer)
- awsCredentials_secretAccessKey :: Lens' AwsCredentials (Maybe Text)
- awsCredentials_sessionToken :: Lens' AwsCredentials (Maybe Text)
- data ChangesetErrorInfo = ChangesetErrorInfo' {}
- newChangesetErrorInfo :: ChangesetErrorInfo
- changesetErrorInfo_errorCategory :: Lens' ChangesetErrorInfo (Maybe ErrorCategory)
- changesetErrorInfo_errorMessage :: Lens' ChangesetErrorInfo (Maybe Text)
- data ChangesetSummary = ChangesetSummary' {
- activeFromTimestamp :: Maybe Integer
- activeUntilTimestamp :: Maybe Integer
- changeType :: Maybe ChangeType
- changesetArn :: Maybe Text
- changesetId :: Maybe Text
- createTime :: Maybe Integer
- datasetId :: Maybe Text
- errorInfo :: Maybe ChangesetErrorInfo
- formatParams :: Maybe (HashMap Text Text)
- sourceParams :: Maybe (HashMap Text Text)
- status :: Maybe IngestionStatus
- updatedByChangesetId :: Maybe Text
- updatesChangesetId :: Maybe Text
- newChangesetSummary :: ChangesetSummary
- changesetSummary_activeFromTimestamp :: Lens' ChangesetSummary (Maybe Integer)
- changesetSummary_activeUntilTimestamp :: Lens' ChangesetSummary (Maybe Integer)
- changesetSummary_changeType :: Lens' ChangesetSummary (Maybe ChangeType)
- changesetSummary_changesetArn :: Lens' ChangesetSummary (Maybe Text)
- changesetSummary_changesetId :: Lens' ChangesetSummary (Maybe Text)
- changesetSummary_createTime :: Lens' ChangesetSummary (Maybe Integer)
- changesetSummary_datasetId :: Lens' ChangesetSummary (Maybe Text)
- changesetSummary_errorInfo :: Lens' ChangesetSummary (Maybe ChangesetErrorInfo)
- changesetSummary_formatParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text))
- changesetSummary_sourceParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text))
- changesetSummary_status :: Lens' ChangesetSummary (Maybe IngestionStatus)
- changesetSummary_updatedByChangesetId :: Lens' ChangesetSummary (Maybe Text)
- changesetSummary_updatesChangesetId :: Lens' ChangesetSummary (Maybe Text)
- data ColumnDefinition = ColumnDefinition' {}
- newColumnDefinition :: ColumnDefinition
- columnDefinition_columnDescription :: Lens' ColumnDefinition (Maybe Text)
- columnDefinition_columnName :: Lens' ColumnDefinition (Maybe Text)
- columnDefinition_dataType :: Lens' ColumnDefinition (Maybe ColumnDataType)
- data Credentials = Credentials' {}
- newCredentials :: Credentials
- credentials_accessKeyId :: Lens' Credentials (Maybe Text)
- credentials_secretAccessKey :: Lens' Credentials (Maybe Text)
- credentials_sessionToken :: Lens' Credentials (Maybe Text)
- data DataViewDestinationTypeParams = DataViewDestinationTypeParams' {}
- newDataViewDestinationTypeParams :: Text -> DataViewDestinationTypeParams
- dataViewDestinationTypeParams_s3DestinationExportFileFormat :: Lens' DataViewDestinationTypeParams (Maybe ExportFileFormat)
- dataViewDestinationTypeParams_s3DestinationExportFileFormatOptions :: Lens' DataViewDestinationTypeParams (Maybe (HashMap Text Text))
- dataViewDestinationTypeParams_destinationType :: Lens' DataViewDestinationTypeParams Text
- data DataViewErrorInfo = DataViewErrorInfo' {}
- newDataViewErrorInfo :: DataViewErrorInfo
- dataViewErrorInfo_errorCategory :: Lens' DataViewErrorInfo (Maybe ErrorCategory)
- dataViewErrorInfo_errorMessage :: Lens' DataViewErrorInfo (Maybe Text)
- data DataViewSummary = DataViewSummary' {
- asOfTimestamp :: Maybe Integer
- autoUpdate :: Maybe Bool
- createTime :: Maybe Integer
- dataViewArn :: Maybe Text
- dataViewId :: Maybe Text
- datasetId :: Maybe Text
- destinationTypeProperties :: Maybe DataViewDestinationTypeParams
- errorInfo :: Maybe DataViewErrorInfo
- lastModifiedTime :: Maybe Integer
- partitionColumns :: Maybe [Text]
- sortColumns :: Maybe [Text]
- status :: Maybe DataViewStatus
- newDataViewSummary :: DataViewSummary
- dataViewSummary_asOfTimestamp :: Lens' DataViewSummary (Maybe Integer)
- dataViewSummary_autoUpdate :: Lens' DataViewSummary (Maybe Bool)
- dataViewSummary_createTime :: Lens' DataViewSummary (Maybe Integer)
- dataViewSummary_dataViewArn :: Lens' DataViewSummary (Maybe Text)
- dataViewSummary_dataViewId :: Lens' DataViewSummary (Maybe Text)
- dataViewSummary_datasetId :: Lens' DataViewSummary (Maybe Text)
- dataViewSummary_destinationTypeProperties :: Lens' DataViewSummary (Maybe DataViewDestinationTypeParams)
- dataViewSummary_errorInfo :: Lens' DataViewSummary (Maybe DataViewErrorInfo)
- dataViewSummary_lastModifiedTime :: Lens' DataViewSummary (Maybe Integer)
- dataViewSummary_partitionColumns :: Lens' DataViewSummary (Maybe [Text])
- dataViewSummary_sortColumns :: Lens' DataViewSummary (Maybe [Text])
- dataViewSummary_status :: Lens' DataViewSummary (Maybe DataViewStatus)
- data Dataset = Dataset' {}
- newDataset :: Dataset
- dataset_alias :: Lens' Dataset (Maybe Text)
- dataset_createTime :: Lens' Dataset (Maybe Integer)
- dataset_datasetArn :: Lens' Dataset (Maybe Text)
- dataset_datasetDescription :: Lens' Dataset (Maybe Text)
- dataset_datasetId :: Lens' Dataset (Maybe Text)
- dataset_datasetTitle :: Lens' Dataset (Maybe Text)
- dataset_kind :: Lens' Dataset (Maybe DatasetKind)
- dataset_lastModifiedTime :: Lens' Dataset (Maybe Integer)
- dataset_ownerInfo :: Lens' Dataset (Maybe DatasetOwnerInfo)
- dataset_schemaDefinition :: Lens' Dataset (Maybe SchemaUnion)
- data DatasetOwnerInfo = DatasetOwnerInfo' {}
- newDatasetOwnerInfo :: DatasetOwnerInfo
- datasetOwnerInfo_email :: Lens' DatasetOwnerInfo (Maybe Text)
- datasetOwnerInfo_name :: Lens' DatasetOwnerInfo (Maybe Text)
- datasetOwnerInfo_phoneNumber :: Lens' DatasetOwnerInfo (Maybe Text)
- data PermissionGroup = PermissionGroup' {}
- newPermissionGroup :: PermissionGroup
- permissionGroup_applicationPermissions :: Lens' PermissionGroup (Maybe [ApplicationPermission])
- permissionGroup_createTime :: Lens' PermissionGroup (Maybe Integer)
- permissionGroup_description :: Lens' PermissionGroup (Maybe Text)
- permissionGroup_lastModifiedTime :: Lens' PermissionGroup (Maybe Integer)
- permissionGroup_membershipStatus :: Lens' PermissionGroup (Maybe PermissionGroupMembershipStatus)
- permissionGroup_name :: Lens' PermissionGroup (Maybe Text)
- permissionGroup_permissionGroupId :: Lens' PermissionGroup (Maybe Text)
- data PermissionGroupByUser = PermissionGroupByUser' {}
- newPermissionGroupByUser :: PermissionGroupByUser
- permissionGroupByUser_membershipStatus :: Lens' PermissionGroupByUser (Maybe PermissionGroupMembershipStatus)
- permissionGroupByUser_name :: Lens' PermissionGroupByUser (Maybe Text)
- permissionGroupByUser_permissionGroupId :: Lens' PermissionGroupByUser (Maybe Text)
- data PermissionGroupParams = PermissionGroupParams' {}
- newPermissionGroupParams :: PermissionGroupParams
- permissionGroupParams_datasetPermissions :: Lens' PermissionGroupParams (Maybe [ResourcePermission])
- permissionGroupParams_permissionGroupId :: Lens' PermissionGroupParams (Maybe Text)
- data ResourcePermission = ResourcePermission' {
- permission :: Maybe Text
- newResourcePermission :: ResourcePermission
- resourcePermission_permission :: Lens' ResourcePermission (Maybe Text)
- data S3Location = S3Location' {}
- newS3Location :: Text -> Text -> S3Location
- s3Location_bucket :: Lens' S3Location Text
- s3Location_key :: Lens' S3Location Text
- data SchemaDefinition = SchemaDefinition' {
- columns :: Maybe [ColumnDefinition]
- primaryKeyColumns :: Maybe [Text]
- newSchemaDefinition :: SchemaDefinition
- schemaDefinition_columns :: Lens' SchemaDefinition (Maybe [ColumnDefinition])
- schemaDefinition_primaryKeyColumns :: Lens' SchemaDefinition (Maybe [Text])
- data SchemaUnion = SchemaUnion' {}
- newSchemaUnion :: SchemaUnion
- schemaUnion_tabularSchemaConfig :: Lens' SchemaUnion (Maybe SchemaDefinition)
- data User = User' {
- apiAccess :: Maybe ApiAccess
- apiAccessPrincipalArn :: Maybe Text
- createTime :: Maybe Integer
- emailAddress :: Maybe (Sensitive Text)
- firstName :: Maybe (Sensitive Text)
- lastDisabledTime :: Maybe Integer
- lastEnabledTime :: Maybe Integer
- lastLoginTime :: Maybe Integer
- lastModifiedTime :: Maybe Integer
- lastName :: Maybe (Sensitive Text)
- status :: Maybe UserStatus
- type' :: Maybe UserType
- userId :: Maybe Text
- newUser :: User
- user_apiAccess :: Lens' User (Maybe ApiAccess)
- user_apiAccessPrincipalArn :: Lens' User (Maybe Text)
- user_createTime :: Lens' User (Maybe Integer)
- user_emailAddress :: Lens' User (Maybe Text)
- user_firstName :: Lens' User (Maybe Text)
- user_lastDisabledTime :: Lens' User (Maybe Integer)
- user_lastEnabledTime :: Lens' User (Maybe Integer)
- user_lastLoginTime :: Lens' User (Maybe Integer)
- user_lastModifiedTime :: Lens' User (Maybe Integer)
- user_lastName :: Lens' User (Maybe Text)
- user_status :: Lens' User (Maybe UserStatus)
- user_type :: Lens' User (Maybe UserType)
- user_userId :: Lens' User (Maybe Text)
- data UserByPermissionGroup = UserByPermissionGroup' {}
- newUserByPermissionGroup :: UserByPermissionGroup
- userByPermissionGroup_apiAccess :: Lens' UserByPermissionGroup (Maybe ApiAccess)
- userByPermissionGroup_apiAccessPrincipalArn :: Lens' UserByPermissionGroup (Maybe Text)
- userByPermissionGroup_emailAddress :: Lens' UserByPermissionGroup (Maybe Text)
- userByPermissionGroup_firstName :: Lens' UserByPermissionGroup (Maybe Text)
- userByPermissionGroup_lastName :: Lens' UserByPermissionGroup (Maybe Text)
- userByPermissionGroup_membershipStatus :: Lens' UserByPermissionGroup (Maybe PermissionGroupMembershipStatus)
- userByPermissionGroup_status :: Lens' UserByPermissionGroup (Maybe UserStatus)
- userByPermissionGroup_type :: Lens' UserByPermissionGroup (Maybe UserType)
- userByPermissionGroup_userId :: Lens' UserByPermissionGroup (Maybe Text)
Service Configuration
defaultService :: Service Source #
API version 2020-07-13 of the Amazon FinSpace Public API SDK configuration.
Errors
_AccessDeniedException :: AsError a => Fold a ServiceError Source #
You do not have sufficient access to perform this action.
_ConflictException :: AsError a => Fold a ServiceError Source #
The request conflicts with an existing resource.
_InternalServerException :: AsError a => Fold a ServiceError Source #
The request processing has failed because of an unknown error, exception or failure.
_LimitExceededException :: AsError a => Fold a ServiceError Source #
A limit has exceeded.
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
One or more resources can't be found.
_ThrottlingException :: AsError a => Fold a ServiceError Source #
The request was denied due to request throttling.
_ValidationException :: AsError a => Fold a ServiceError Source #
The input fails to satisfy the constraints specified by an AWS service.
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' | |
Fields
| |
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.
awsCredentials_accessKeyId :: Lens' AwsCredentials (Maybe Text) Source #
The unique identifier for the security credentials.
awsCredentials_expiration :: Lens' AwsCredentials (Maybe Integer) Source #
The Epoch time when the current credentials expire.
awsCredentials_secretAccessKey :: Lens' AwsCredentials (Maybe Text) Source #
The secret access key that can be used to sign requests.
awsCredentials_sessionToken :: Lens' AwsCredentials (Maybe Text) Source #
The token that users must pass to use the credentials.
ChangesetErrorInfo
data ChangesetErrorInfo Source #
The structure with error messages.
See: newChangesetErrorInfo smart constructor.
Constructors
| ChangesetErrorInfo' | |
Fields
| |
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.
changesetErrorInfo_errorCategory :: Lens' ChangesetErrorInfo (Maybe ErrorCategory) Source #
The category of the error.
VALIDATION– The inputs to this request are invalid.SERVICE_QUOTA_EXCEEDED– Service quotas have been exceeded. Please contact AWS support to increase quotas.ACCESS_DENIED– Missing required permission to perform this request.RESOURCE_NOT_FOUND– One or more inputs to this request were not found.THROTTLING– The system temporarily lacks sufficient resources to process the request.INTERNAL_SERVICE_EXCEPTION– An internal service error has occurred.CANCELLED– Cancelled.USER_RECOVERABLE– A user recoverable error has occurred.
changesetErrorInfo_errorMessage :: Lens' ChangesetErrorInfo (Maybe Text) Source #
The text of the error message.
ChangesetSummary
data ChangesetSummary Source #
A Changeset is unit of data in a Dataset.
See: newChangesetSummary smart constructor.
Constructors
| ChangesetSummary' | |
Fields
| |
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.
changesetSummary_activeFromTimestamp :: Lens' ChangesetSummary (Maybe Integer) Source #
Beginning time from which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
changesetSummary_activeUntilTimestamp :: Lens' ChangesetSummary (Maybe Integer) Source #
Time until which the Changeset is active. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
changesetSummary_changeType :: Lens' ChangesetSummary (Maybe ChangeType) Source #
Type that indicates how a Changeset is applied to a Dataset.
REPLACE– Changeset is considered as a replacement to all prior loaded Changesets.APPEND– Changeset is considered as an addition to the end of all prior loaded Changesets.MODIFY– Changeset is considered as a replacement to a specific prior ingested Changeset.
changesetSummary_changesetArn :: Lens' ChangesetSummary (Maybe Text) Source #
The ARN identifier of the Changeset.
changesetSummary_changesetId :: Lens' ChangesetSummary (Maybe Text) Source #
The unique identifier for a Changeset.
changesetSummary_createTime :: Lens' ChangesetSummary (Maybe Integer) Source #
The timestamp at which the Changeset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
changesetSummary_datasetId :: Lens' ChangesetSummary (Maybe Text) Source #
The unique identifier for the FinSpace Dataset in which the Changeset is created.
changesetSummary_errorInfo :: Lens' ChangesetSummary (Maybe ChangesetErrorInfo) Source #
The structure with error messages.
changesetSummary_formatParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text)) Source #
Options that define the structure of the source file(s).
changesetSummary_sourceParams :: Lens' ChangesetSummary (Maybe (HashMap Text Text)) Source #
Options that define the location of the data being ingested.
changesetSummary_status :: Lens' ChangesetSummary (Maybe IngestionStatus) Source #
Status of the Changeset ingestion.
PENDING– Changeset is pending creation.FAILED– Changeset creation has failed.SUCCESS– Changeset creation has succeeded.RUNNING– Changeset creation is running.STOP_REQUESTED– User requested Changeset creation to stop.
changesetSummary_updatedByChangesetId :: Lens' ChangesetSummary (Maybe Text) Source #
The unique identifier of the updated Changeset.
changesetSummary_updatesChangesetId :: Lens' ChangesetSummary (Maybe Text) Source #
The unique identifier of the Changeset that is updated.
ColumnDefinition
data ColumnDefinition Source #
The definition of a column in a tabular Dataset.
See: newColumnDefinition smart constructor.
Constructors
| ColumnDefinition' | |
Fields
| |
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.
columnDefinition_columnDescription :: Lens' ColumnDefinition (Maybe Text) Source #
Description for a column.
columnDefinition_columnName :: Lens' ColumnDefinition (Maybe Text) Source #
The name of a column.
columnDefinition_dataType :: Lens' ColumnDefinition (Maybe ColumnDataType) Source #
Data type of a column.
STRING– A String data type.CHAR– A char data type.INTEGER– An integer data type.TINYINT– A tinyint data type.SMALLINT– A smallint data type.BIGINT– A bigint data type.FLOAT– A float data type.DOUBLE– A double data type.DATE– A date data type.DATETIME– A datetime data type.BOOLEAN– A boolean data type.BINARY– A binary data type.
Credentials
data Credentials Source #
Short term API credentials.
See: newCredentials smart constructor.
Constructors
| Credentials' | |
Fields
| |
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.
credentials_accessKeyId :: Lens' Credentials (Maybe Text) Source #
The access key identifier.
credentials_secretAccessKey :: Lens' Credentials (Maybe Text) Source #
The access key.
credentials_sessionToken :: Lens' Credentials (Maybe Text) Source #
The session token.
DataViewDestinationTypeParams
data DataViewDestinationTypeParams Source #
Structure for the Dataview destination type parameters.
See: newDataViewDestinationTypeParams smart constructor.
Constructors
| DataViewDestinationTypeParams' | |
Fields
| |
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.
dataViewDestinationTypeParams_s3DestinationExportFileFormat :: Lens' DataViewDestinationTypeParams (Maybe ExportFileFormat) Source #
Dataview export file format.
PARQUET– Parquet export file format.DELIMITED_TEXT– Delimited text export file format.
dataViewDestinationTypeParams_s3DestinationExportFileFormatOptions :: Lens' DataViewDestinationTypeParams (Maybe (HashMap Text Text)) Source #
Format Options for S3 Destination type.
Here is an example of how you could specify the
s3DestinationExportFileFormatOptions
{ "header": "true", "delimiter": ",", "compression": "gzip" }dataViewDestinationTypeParams_destinationType :: Lens' DataViewDestinationTypeParams Text Source #
Destination type for a Dataview.
GLUE_TABLE– Glue table destination type.S3– S3 destination type.
DataViewErrorInfo
data DataViewErrorInfo Source #
The structure with error messages.
See: newDataViewErrorInfo smart constructor.
Constructors
| DataViewErrorInfo' | |
Fields
| |
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.
dataViewErrorInfo_errorCategory :: Lens' DataViewErrorInfo (Maybe ErrorCategory) Source #
The category of the error.
VALIDATION– The inputs to this request are invalid.SERVICE_QUOTA_EXCEEDED– Service quotas have been exceeded. Please contact AWS support to increase quotas.ACCESS_DENIED– Missing required permission to perform this request.RESOURCE_NOT_FOUND– One or more inputs to this request were not found.THROTTLING– The system temporarily lacks sufficient resources to process the request.INTERNAL_SERVICE_EXCEPTION– An internal service error has occurred.CANCELLED– Cancelled.USER_RECOVERABLE– A user recoverable error has occurred.
dataViewErrorInfo_errorMessage :: Lens' DataViewErrorInfo (Maybe Text) Source #
The text of the error message.
DataViewSummary
data DataViewSummary Source #
Structure for the summary of a Dataview.
See: newDataViewSummary smart constructor.
Constructors
| DataViewSummary' | |
Fields
| |
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.
dataViewSummary_asOfTimestamp :: Lens' DataViewSummary (Maybe Integer) Source #
Time range to use for the Dataview. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
dataViewSummary_autoUpdate :: Lens' DataViewSummary (Maybe Bool) Source #
The flag to indicate Dataview should be updated automatically.
dataViewSummary_createTime :: Lens' DataViewSummary (Maybe Integer) Source #
The timestamp at which the Dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
dataViewSummary_dataViewArn :: Lens' DataViewSummary (Maybe Text) Source #
The ARN identifier of the Dataview.
dataViewSummary_dataViewId :: Lens' DataViewSummary (Maybe Text) Source #
The unique identifier for the Dataview.
dataViewSummary_datasetId :: Lens' DataViewSummary (Maybe Text) Source #
Th unique identifier for the Dataview Dataset.
dataViewSummary_destinationTypeProperties :: Lens' DataViewSummary (Maybe DataViewDestinationTypeParams) Source #
Information about the Dataview destination.
dataViewSummary_errorInfo :: Lens' DataViewSummary (Maybe DataViewErrorInfo) Source #
The structure with error messages.
dataViewSummary_lastModifiedTime :: Lens' DataViewSummary (Maybe Integer) Source #
The last time that a Dataview was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
dataViewSummary_partitionColumns :: Lens' DataViewSummary (Maybe [Text]) Source #
Ordered set of column names used to partition data.
dataViewSummary_sortColumns :: Lens' DataViewSummary (Maybe [Text]) Source #
Columns to be used for sorting the data.
dataViewSummary_status :: Lens' DataViewSummary (Maybe DataViewStatus) Source #
The status of a Dataview creation.
RUNNING– Dataview creation is running.STARTING– Dataview creation is starting.FAILED– Dataview creation has failed.CANCELLED– Dataview creation has been cancelled.TIMEOUT– Dataview creation has timed out.SUCCESS– Dataview creation has succeeded.PENDING– Dataview creation is pending.FAILED_CLEANUP_FAILED– Dataview creation failed and resource cleanup failed.
Dataset
The structure for a Dataset.
See: newDataset smart constructor.
Constructors
| Dataset' | |
Fields
| |
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.
dataset_createTime :: Lens' Dataset (Maybe Integer) Source #
The timestamp at which the Dataset was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
dataset_kind :: Lens' Dataset (Maybe DatasetKind) Source #
The format in which Dataset data is structured.
TABULAR– Data is structured in a tabular format.NON_TABULAR– Data is structured in a non-tabular format.
dataset_lastModifiedTime :: Lens' Dataset (Maybe Integer) Source #
The last time that the Dataset was modified. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.
dataset_ownerInfo :: Lens' Dataset (Maybe DatasetOwnerInfo) Source #
Contact information for a Dataset owner.
dataset_schemaDefinition :: Lens' Dataset (Maybe SchemaUnion) Source #
Definition for a schema on a tabular Dataset.
DatasetOwnerInfo
data DatasetOwnerInfo Source #
A structure for Dataset owner info.
See: newDatasetOwnerInfo smart constructor.
Constructors
| DatasetOwnerInfo' | |
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.
datasetOwnerInfo_email :: Lens' DatasetOwnerInfo (Maybe Text) Source #
Email address for the Dataset owner.
datasetOwnerInfo_name :: Lens' DatasetOwnerInfo (Maybe Text) Source #
The name of the Dataset owner.
datasetOwnerInfo_phoneNumber :: Lens' DatasetOwnerInfo (Maybe Text) Source #
Phone number for the Dataset owner.
PermissionGroup
data PermissionGroup Source #
The structure for a permission group.
See: newPermissionGroup smart constructor.
Constructors
| PermissionGroup' | |
Fields
| |
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.
permissionGroup_applicationPermissions :: Lens' PermissionGroup (Maybe [ApplicationPermission]) Source #
Indicates the permissions that are granted to a specific group for accessing the FinSpace application.
When assigning application permissions, be aware that the permission
ManageUsersAndGroups allows users to grant themselves or others access
to any functionality in their FinSpace environment's application. It
should only be granted to trusted users.
CreateDataset– Group members can create new datasets.ManageClusters– Group members can manage Apache Spark clusters from FinSpace notebooks.ManageUsersAndGroups– Group members can manage users and permission groups. This is a privileged permission that allows users to grant themselves or others access to any functionality in the application. It should only be granted to trusted users.ManageAttributeSets– Group members can manage attribute sets.ViewAuditData– Group members can view audit data.AccessNotebooks– Group members will have access to FinSpace notebooks.GetTemporaryCredentials– Group members can get temporary API credentials.
permissionGroup_createTime :: Lens' PermissionGroup (Maybe Integer) Source #
The timestamp at which the group was created in FinSpace. The value is determined as epoch time in milliseconds.
permissionGroup_description :: Lens' PermissionGroup (Maybe Text) Source #
A brief description for the permission group.
permissionGroup_lastModifiedTime :: Lens' PermissionGroup (Maybe Integer) Source #
Describes the last time the permission group was updated. The value is determined as epoch time in milliseconds.
permissionGroup_membershipStatus :: Lens' PermissionGroup (Maybe PermissionGroupMembershipStatus) Source #
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS– The user account is currently being added to the permission group.ADDITION_SUCCESS– The user account is successfully added to the permission group.REMOVAL_IN_PROGRESS– The user is currently being removed from the permission group.
permissionGroup_name :: Lens' PermissionGroup (Maybe Text) Source #
The name of the permission group.
permissionGroup_permissionGroupId :: Lens' PermissionGroup (Maybe Text) Source #
The unique identifier for the permission group.
PermissionGroupByUser
data PermissionGroupByUser Source #
The structure of a permission group associated with a user account.
See: newPermissionGroupByUser smart constructor.
Constructors
| PermissionGroupByUser' | |
Fields
| |
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.
permissionGroupByUser_membershipStatus :: Lens' PermissionGroupByUser (Maybe PermissionGroupMembershipStatus) Source #
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS– The user account is currently being added to the permission group.ADDITION_SUCCESS– The user account is successfully added to the permission group.REMOVAL_IN_PROGRESS– The user is currently being removed from the permission group.
permissionGroupByUser_name :: Lens' PermissionGroupByUser (Maybe Text) Source #
The name of the permission group.
permissionGroupByUser_permissionGroupId :: Lens' PermissionGroupByUser (Maybe Text) Source #
The unique identifier for the permission group.
PermissionGroupParams
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' | |
Fields
| |
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.
permissionGroupParams_datasetPermissions :: Lens' PermissionGroupParams (Maybe [ResourcePermission]) Source #
List of resource permissions.
permissionGroupParams_permissionGroupId :: Lens' PermissionGroupParams (Maybe Text) Source #
The unique identifier for the PermissionGroup.
ResourcePermission
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' | |
Fields
| |
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.
resourcePermission_permission :: Lens' ResourcePermission (Maybe Text) Source #
Permission for a resource.
S3Location
data S3Location Source #
The location of an external Dataview in an S3 bucket.
See: newS3Location smart constructor.
Constructors
| S3Location' | |
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.
s3Location_bucket :: Lens' S3Location Text Source #
The name of the S3 bucket.
s3Location_key :: Lens' S3Location Text Source #
The path of the folder, within the S3 bucket that contains the Dataset.
SchemaDefinition
data SchemaDefinition Source #
Definition for a schema on a tabular Dataset.
See: newSchemaDefinition smart constructor.
Constructors
| SchemaDefinition' | |
Fields
| |
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.
schemaDefinition_columns :: Lens' SchemaDefinition (Maybe [ColumnDefinition]) Source #
List of column definitions.
schemaDefinition_primaryKeyColumns :: Lens' SchemaDefinition (Maybe [Text]) Source #
List of column names used for primary key.
SchemaUnion
data SchemaUnion Source #
A union of schema types.
See: newSchemaUnion smart constructor.
Constructors
| SchemaUnion' | |
Fields
| |
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.
schemaUnion_tabularSchemaConfig :: Lens' SchemaUnion (Maybe SchemaDefinition) Source #
The configuration for a schema on a tabular Dataset.
User
The details of the user account.
See: newUser smart constructor.
Constructors
| User' | |
Fields
| |
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.
user_apiAccess :: Lens' User (Maybe ApiAccess) Source #
Indicates whether the user can use the
GetProgrammaticAccessCredentials API to obtain credentials that can
then be used to access other FinSpace Data API operations.
ENABLED– The user has permissions to use the APIs.DISABLED– The user does not have permissions to use any APIs.
user_apiAccessPrincipalArn :: Lens' User (Maybe Text) Source #
The ARN identifier of an AWS user or role that is allowed to call the
GetProgrammaticAccessCredentials API to obtain a credentials token for
a specific FinSpace user. This must be an IAM role within your FinSpace
account.
user_createTime :: Lens' User (Maybe Integer) Source #
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
user_emailAddress :: Lens' User (Maybe Text) Source #
The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
user_lastDisabledTime :: Lens' User (Maybe Integer) Source #
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
user_lastEnabledTime :: Lens' User (Maybe Integer) Source #
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
user_lastLoginTime :: Lens' User (Maybe Integer) Source #
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
user_lastModifiedTime :: Lens' User (Maybe Integer) Source #
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
user_status :: Lens' User (Maybe UserStatus) Source #
The current status of the user account.
CREATING– The user account creation is in progress.ENABLED– The user account is created and is currently active.DISABLED– The user account is currently inactive.
user_type :: Lens' User (Maybe UserType) Source #
Indicates the type of user.
SUPER_USER– A user with permission to all the functionality and data in FinSpace.APP_USER– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
UserByPermissionGroup
data UserByPermissionGroup Source #
The structure of a user account associated with a permission group.
See: newUserByPermissionGroup smart constructor.
Constructors
| UserByPermissionGroup' | |
Fields
| |
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.
userByPermissionGroup_apiAccess :: Lens' UserByPermissionGroup (Maybe ApiAccess) Source #
Indicates whether the user can access FinSpace API operations.
ENABLED– The user has permissions to use the API operations.DISABLED– The user does not have permissions to use any API operations.
userByPermissionGroup_apiAccessPrincipalArn :: Lens' UserByPermissionGroup (Maybe Text) Source #
The IAM ARN identifier that is attached to FinSpace API calls.
userByPermissionGroup_emailAddress :: Lens' UserByPermissionGroup (Maybe Text) Source #
The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it's created.
userByPermissionGroup_firstName :: Lens' UserByPermissionGroup (Maybe Text) Source #
The first name of the user.
userByPermissionGroup_lastName :: Lens' UserByPermissionGroup (Maybe Text) Source #
The last name of the user.
userByPermissionGroup_membershipStatus :: Lens' UserByPermissionGroup (Maybe PermissionGroupMembershipStatus) Source #
Indicates the status of the user account within a permission group.
ADDITION_IN_PROGRESS– The user account is currently being added to the permission group.ADDITION_SUCCESS– The user account is successfully added to the permission group.REMOVAL_IN_PROGRESS– The user is currently being removed from the permission group.
userByPermissionGroup_status :: Lens' UserByPermissionGroup (Maybe UserStatus) Source #
The current status of the user account.
CREATING– The user account creation is in progress.ENABLED– The user account is created and is currently active.DISABLED– The user account is currently inactive.
userByPermissionGroup_type :: Lens' UserByPermissionGroup (Maybe UserType) Source #
Indicates the type of user.
SUPER_USER– A user with permission to all the functionality and data in FinSpace.APP_USER– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
userByPermissionGroup_userId :: Lens' UserByPermissionGroup (Maybe Text) Source #
The unique identifier for the user.