Skip to content

Type definitions#

Index > FinSpaceData > Type definitions

Auto-generated documentation for FinSpaceData type annotations stubs module mypy-boto3-finspace-data.

AssociateUserToPermissionGroupRequestRequestTypeDef#

# AssociateUserToPermissionGroupRequestRequestTypeDef definition

class AssociateUserToPermissionGroupRequestRequestTypeDef(TypedDict):
    permissionGroupId: str,
    userId: str,
    clientToken: NotRequired[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

AwsCredentialsTypeDef#

# AwsCredentialsTypeDef definition

class AwsCredentialsTypeDef(TypedDict):
    accessKeyId: NotRequired[str],
    secretAccessKey: NotRequired[str],
    sessionToken: NotRequired[str],
    expiration: NotRequired[int],

ChangesetErrorInfoTypeDef#

# ChangesetErrorInfoTypeDef definition

class ChangesetErrorInfoTypeDef(TypedDict):
    errorMessage: NotRequired[str],
    errorCategory: NotRequired[ErrorCategoryType],  # (1)
  1. See ErrorCategoryType

ColumnDefinitionTypeDef#

# ColumnDefinitionTypeDef definition

class ColumnDefinitionTypeDef(TypedDict):
    dataType: NotRequired[ColumnDataTypeType],  # (1)
    columnName: NotRequired[str],
    columnDescription: NotRequired[str],
  1. See ColumnDataTypeType

CreateChangesetRequestRequestTypeDef#

# CreateChangesetRequestRequestTypeDef definition

class CreateChangesetRequestRequestTypeDef(TypedDict):
    datasetId: str,
    changeType: ChangeTypeType,  # (1)
    sourceParams: Mapping[str, str],
    formatParams: Mapping[str, str],
    clientToken: NotRequired[str],
  1. See ChangeTypeType

DataViewDestinationTypeParamsTypeDef#

# DataViewDestinationTypeParamsTypeDef definition

class DataViewDestinationTypeParamsTypeDef(TypedDict):
    destinationType: str,
    s3DestinationExportFileFormat: NotRequired[ExportFileFormatType],  # (1)
    s3DestinationExportFileFormatOptions: NotRequired[Mapping[str, str]],
  1. See ExportFileFormatType

DatasetOwnerInfoTypeDef#

# DatasetOwnerInfoTypeDef definition

class DatasetOwnerInfoTypeDef(TypedDict):
    name: NotRequired[str],
    phoneNumber: NotRequired[str],
    email: NotRequired[str],

CreatePermissionGroupRequestRequestTypeDef#

# CreatePermissionGroupRequestRequestTypeDef definition

class CreatePermissionGroupRequestRequestTypeDef(TypedDict):
    name: str,
    applicationPermissions: Sequence[ApplicationPermissionType],  # (1)
    description: NotRequired[str],
    clientToken: NotRequired[str],
  1. See ApplicationPermissionType

CreateUserRequestRequestTypeDef#

# CreateUserRequestRequestTypeDef definition

class CreateUserRequestRequestTypeDef(TypedDict):
    emailAddress: str,
    type: UserTypeType,  # (1)
    firstName: NotRequired[str],
    lastName: NotRequired[str],
    apiAccess: NotRequired[ApiAccessType],  # (2)
    apiAccessPrincipalArn: NotRequired[str],
    clientToken: NotRequired[str],
  1. See UserTypeType
  2. See ApiAccessType

CredentialsTypeDef#

# CredentialsTypeDef definition

class CredentialsTypeDef(TypedDict):
    accessKeyId: NotRequired[str],
    secretAccessKey: NotRequired[str],
    sessionToken: NotRequired[str],

DataViewDestinationTypeParamsPaginatorTypeDef#

# DataViewDestinationTypeParamsPaginatorTypeDef definition

class DataViewDestinationTypeParamsPaginatorTypeDef(TypedDict):
    destinationType: str,
    s3DestinationExportFileFormat: NotRequired[ExportFileFormatType],  # (1)
    s3DestinationExportFileFormatOptions: NotRequired[Dict[str, str]],
  1. See ExportFileFormatType

DataViewErrorInfoTypeDef#

# DataViewErrorInfoTypeDef definition

class DataViewErrorInfoTypeDef(TypedDict):
    errorMessage: NotRequired[str],
    errorCategory: NotRequired[ErrorCategoryType],  # (1)
  1. See ErrorCategoryType

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    datasetId: str,
    clientToken: NotRequired[str],

DeletePermissionGroupRequestRequestTypeDef#

# DeletePermissionGroupRequestRequestTypeDef definition

class DeletePermissionGroupRequestRequestTypeDef(TypedDict):
    permissionGroupId: str,
    clientToken: NotRequired[str],

DisableUserRequestRequestTypeDef#

# DisableUserRequestRequestTypeDef definition

class DisableUserRequestRequestTypeDef(TypedDict):
    userId: str,
    clientToken: NotRequired[str],

DisassociateUserFromPermissionGroupRequestRequestTypeDef#

# DisassociateUserFromPermissionGroupRequestRequestTypeDef definition

class DisassociateUserFromPermissionGroupRequestRequestTypeDef(TypedDict):
    permissionGroupId: str,
    userId: str,
    clientToken: NotRequired[str],

EnableUserRequestRequestTypeDef#

# EnableUserRequestRequestTypeDef definition

class EnableUserRequestRequestTypeDef(TypedDict):
    userId: str,
    clientToken: NotRequired[str],

GetChangesetRequestRequestTypeDef#

# GetChangesetRequestRequestTypeDef definition

class GetChangesetRequestRequestTypeDef(TypedDict):
    datasetId: str,
    changesetId: str,

GetDataViewRequestRequestTypeDef#

# GetDataViewRequestRequestTypeDef definition

class GetDataViewRequestRequestTypeDef(TypedDict):
    dataViewId: str,
    datasetId: str,

GetDatasetRequestRequestTypeDef#

# GetDatasetRequestRequestTypeDef definition

class GetDatasetRequestRequestTypeDef(TypedDict):
    datasetId: str,

GetExternalDataViewAccessDetailsRequestRequestTypeDef#

# GetExternalDataViewAccessDetailsRequestRequestTypeDef definition

class GetExternalDataViewAccessDetailsRequestRequestTypeDef(TypedDict):
    dataViewId: str,
    datasetId: str,

S3LocationTypeDef#

# S3LocationTypeDef definition

class S3LocationTypeDef(TypedDict):
    bucket: str,
    key: str,

GetPermissionGroupRequestRequestTypeDef#

# GetPermissionGroupRequestRequestTypeDef definition

class GetPermissionGroupRequestRequestTypeDef(TypedDict):
    permissionGroupId: str,

PermissionGroupTypeDef#

# PermissionGroupTypeDef definition

class PermissionGroupTypeDef(TypedDict):
    permissionGroupId: NotRequired[str],
    name: NotRequired[str],
    description: NotRequired[str],
    applicationPermissions: NotRequired[List[ApplicationPermissionType]],  # (1)
    createTime: NotRequired[int],
    lastModifiedTime: NotRequired[int],
    membershipStatus: NotRequired[PermissionGroupMembershipStatusType],  # (2)
  1. See ApplicationPermissionType
  2. See PermissionGroupMembershipStatusType

GetProgrammaticAccessCredentialsRequestRequestTypeDef#

# GetProgrammaticAccessCredentialsRequestRequestTypeDef definition

class GetProgrammaticAccessCredentialsRequestRequestTypeDef(TypedDict):
    environmentId: str,
    durationInMinutes: NotRequired[int],

GetUserRequestRequestTypeDef#

# GetUserRequestRequestTypeDef definition

class GetUserRequestRequestTypeDef(TypedDict):
    userId: str,

GetWorkingLocationRequestRequestTypeDef#

# GetWorkingLocationRequestRequestTypeDef definition

class GetWorkingLocationRequestRequestTypeDef(TypedDict):
    locationType: NotRequired[locationTypeType],  # (1)
  1. See locationTypeType

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListChangesetsRequestRequestTypeDef#

# ListChangesetsRequestRequestTypeDef definition

class ListChangesetsRequestRequestTypeDef(TypedDict):
    datasetId: str,
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListDataViewsRequestRequestTypeDef#

# ListDataViewsRequestRequestTypeDef definition

class ListDataViewsRequestRequestTypeDef(TypedDict):
    datasetId: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef definition

class ListDatasetsRequestRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListPermissionGroupsByUserRequestRequestTypeDef#

# ListPermissionGroupsByUserRequestRequestTypeDef definition

class ListPermissionGroupsByUserRequestRequestTypeDef(TypedDict):
    userId: str,
    maxResults: int,
    nextToken: NotRequired[str],

PermissionGroupByUserTypeDef#

# PermissionGroupByUserTypeDef definition

class PermissionGroupByUserTypeDef(TypedDict):
    permissionGroupId: NotRequired[str],
    name: NotRequired[str],
    membershipStatus: NotRequired[PermissionGroupMembershipStatusType],  # (1)
  1. See PermissionGroupMembershipStatusType

ListPermissionGroupsRequestRequestTypeDef#

# ListPermissionGroupsRequestRequestTypeDef definition

class ListPermissionGroupsRequestRequestTypeDef(TypedDict):
    maxResults: int,
    nextToken: NotRequired[str],

ListUsersByPermissionGroupRequestRequestTypeDef#

# ListUsersByPermissionGroupRequestRequestTypeDef definition

class ListUsersByPermissionGroupRequestRequestTypeDef(TypedDict):
    permissionGroupId: str,
    maxResults: int,
    nextToken: NotRequired[str],

UserByPermissionGroupTypeDef#

# UserByPermissionGroupTypeDef definition

class UserByPermissionGroupTypeDef(TypedDict):
    userId: NotRequired[str],
    status: NotRequired[UserStatusType],  # (1)
    firstName: NotRequired[str],
    lastName: NotRequired[str],
    emailAddress: NotRequired[str],
    type: NotRequired[UserTypeType],  # (2)
    apiAccess: NotRequired[ApiAccessType],  # (3)
    apiAccessPrincipalArn: NotRequired[str],
    membershipStatus: NotRequired[PermissionGroupMembershipStatusType],  # (4)
  1. See UserStatusType
  2. See UserTypeType
  3. See ApiAccessType
  4. See PermissionGroupMembershipStatusType

ListUsersRequestRequestTypeDef#

# ListUsersRequestRequestTypeDef definition

class ListUsersRequestRequestTypeDef(TypedDict):
    maxResults: int,
    nextToken: NotRequired[str],

UserTypeDef#

# UserTypeDef definition

class UserTypeDef(TypedDict):
    userId: NotRequired[str],
    status: NotRequired[UserStatusType],  # (1)
    firstName: NotRequired[str],
    lastName: NotRequired[str],
    emailAddress: NotRequired[str],
    type: NotRequired[UserTypeType],  # (2)
    apiAccess: NotRequired[ApiAccessType],  # (3)
    apiAccessPrincipalArn: NotRequired[str],
    createTime: NotRequired[int],
    lastEnabledTime: NotRequired[int],
    lastDisabledTime: NotRequired[int],
    lastModifiedTime: NotRequired[int],
    lastLoginTime: NotRequired[int],
  1. See UserStatusType
  2. See UserTypeType
  3. See ApiAccessType

ResourcePermissionTypeDef#

# ResourcePermissionTypeDef definition

class ResourcePermissionTypeDef(TypedDict):
    permission: NotRequired[str],

ResetUserPasswordRequestRequestTypeDef#

# ResetUserPasswordRequestRequestTypeDef definition

class ResetUserPasswordRequestRequestTypeDef(TypedDict):
    userId: str,
    clientToken: NotRequired[str],

UpdateChangesetRequestRequestTypeDef#

# UpdateChangesetRequestRequestTypeDef definition

class UpdateChangesetRequestRequestTypeDef(TypedDict):
    datasetId: str,
    changesetId: str,
    sourceParams: Mapping[str, str],
    formatParams: Mapping[str, str],
    clientToken: NotRequired[str],

UpdatePermissionGroupRequestRequestTypeDef#

# UpdatePermissionGroupRequestRequestTypeDef definition

class UpdatePermissionGroupRequestRequestTypeDef(TypedDict):
    permissionGroupId: str,
    name: NotRequired[str],
    description: NotRequired[str],
    applicationPermissions: NotRequired[Sequence[ApplicationPermissionType]],  # (1)
    clientToken: NotRequired[str],
  1. See ApplicationPermissionType

UpdateUserRequestRequestTypeDef#

# UpdateUserRequestRequestTypeDef definition

class UpdateUserRequestRequestTypeDef(TypedDict):
    userId: str,
    type: NotRequired[UserTypeType],  # (1)
    firstName: NotRequired[str],
    lastName: NotRequired[str],
    apiAccess: NotRequired[ApiAccessType],  # (2)
    apiAccessPrincipalArn: NotRequired[str],
    clientToken: NotRequired[str],
  1. See UserTypeType
  2. See ApiAccessType

AssociateUserToPermissionGroupResponseTypeDef#

# AssociateUserToPermissionGroupResponseTypeDef definition

class AssociateUserToPermissionGroupResponseTypeDef(TypedDict):
    statusCode: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateChangesetResponseTypeDef#

# CreateChangesetResponseTypeDef definition

class CreateChangesetResponseTypeDef(TypedDict):
    datasetId: str,
    changesetId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDataViewResponseTypeDef#

# CreateDataViewResponseTypeDef definition

class CreateDataViewResponseTypeDef(TypedDict):
    datasetId: str,
    dataViewId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    datasetId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreatePermissionGroupResponseTypeDef#

# CreatePermissionGroupResponseTypeDef definition

class CreatePermissionGroupResponseTypeDef(TypedDict):
    permissionGroupId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateUserResponseTypeDef#

# CreateUserResponseTypeDef definition

class CreateUserResponseTypeDef(TypedDict):
    userId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeleteDatasetResponseTypeDef#

# DeleteDatasetResponseTypeDef definition

class DeleteDatasetResponseTypeDef(TypedDict):
    datasetId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DeletePermissionGroupResponseTypeDef#

# DeletePermissionGroupResponseTypeDef definition

class DeletePermissionGroupResponseTypeDef(TypedDict):
    permissionGroupId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisableUserResponseTypeDef#

# DisableUserResponseTypeDef definition

class DisableUserResponseTypeDef(TypedDict):
    userId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DisassociateUserFromPermissionGroupResponseTypeDef#

# DisassociateUserFromPermissionGroupResponseTypeDef definition

class DisassociateUserFromPermissionGroupResponseTypeDef(TypedDict):
    statusCode: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EnableUserResponseTypeDef#

# EnableUserResponseTypeDef definition

class EnableUserResponseTypeDef(TypedDict):
    userId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetUserResponseTypeDef#

# GetUserResponseTypeDef definition

class GetUserResponseTypeDef(TypedDict):
    userId: str,
    status: UserStatusType,  # (1)
    firstName: str,
    lastName: str,
    emailAddress: str,
    type: UserTypeType,  # (2)
    apiAccess: ApiAccessType,  # (3)
    apiAccessPrincipalArn: str,
    createTime: int,
    lastEnabledTime: int,
    lastDisabledTime: int,
    lastModifiedTime: int,
    lastLoginTime: int,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See UserStatusType
  2. See UserTypeType
  3. See ApiAccessType
  4. See ResponseMetadataTypeDef

GetWorkingLocationResponseTypeDef#

# GetWorkingLocationResponseTypeDef definition

class GetWorkingLocationResponseTypeDef(TypedDict):
    s3Uri: str,
    s3Path: str,
    s3Bucket: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ResetUserPasswordResponseTypeDef#

# ResetUserPasswordResponseTypeDef definition

class ResetUserPasswordResponseTypeDef(TypedDict):
    userId: str,
    temporaryPassword: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See