Typed dictionaries#
Index > FinSpaceData > Typed dictionaries
Auto-generated documentation for FinSpaceData type annotations stubs module mypy-boto3-finspace-data.
AssociateUserToPermissionGroupRequestRequestTypeDef#
# AssociateUserToPermissionGroupRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import AssociateUserToPermissionGroupRequestRequestTypeDef
def get_value() -> AssociateUserToPermissionGroupRequestRequestTypeDef:
return {
"permissionGroupId": ...,
"userId": ...,
}
# AssociateUserToPermissionGroupRequestRequestTypeDef definition
class AssociateUserToPermissionGroupRequestRequestTypeDef(TypedDict):
permissionGroupId: str,
userId: str,
clientToken: NotRequired[str],
AssociateUserToPermissionGroupResponseTypeDef#
# AssociateUserToPermissionGroupResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import AssociateUserToPermissionGroupResponseTypeDef
def get_value() -> AssociateUserToPermissionGroupResponseTypeDef:
return {
"statusCode": ...,
"ResponseMetadata": ...,
}
# AssociateUserToPermissionGroupResponseTypeDef definition
class AssociateUserToPermissionGroupResponseTypeDef(TypedDict):
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
AwsCredentialsTypeDef#
# AwsCredentialsTypeDef usage example
from mypy_boto3_finspace_data.type_defs import AwsCredentialsTypeDef
def get_value() -> AwsCredentialsTypeDef:
return {
"accessKeyId": ...,
}
# AwsCredentialsTypeDef definition
class AwsCredentialsTypeDef(TypedDict):
accessKeyId: NotRequired[str],
secretAccessKey: NotRequired[str],
sessionToken: NotRequired[str],
expiration: NotRequired[int],
ChangesetErrorInfoTypeDef#
# ChangesetErrorInfoTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ChangesetErrorInfoTypeDef
def get_value() -> ChangesetErrorInfoTypeDef:
return {
"errorMessage": ...,
}
# ChangesetErrorInfoTypeDef definition
class ChangesetErrorInfoTypeDef(TypedDict):
errorMessage: NotRequired[str],
errorCategory: NotRequired[ErrorCategoryType], # (1)
ColumnDefinitionTypeDef#
# ColumnDefinitionTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ColumnDefinitionTypeDef
def get_value() -> ColumnDefinitionTypeDef:
return {
"dataType": ...,
}
# ColumnDefinitionTypeDef definition
class ColumnDefinitionTypeDef(TypedDict):
dataType: NotRequired[ColumnDataTypeType], # (1)
columnName: NotRequired[str],
columnDescription: NotRequired[str],
CreateChangesetRequestRequestTypeDef#
# CreateChangesetRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateChangesetRequestRequestTypeDef
def get_value() -> CreateChangesetRequestRequestTypeDef:
return {
"datasetId": ...,
"changeType": ...,
"sourceParams": ...,
"formatParams": ...,
}
# CreateChangesetRequestRequestTypeDef definition
class CreateChangesetRequestRequestTypeDef(TypedDict):
datasetId: str,
changeType: ChangeTypeType, # (1)
sourceParams: Mapping[str, str],
formatParams: Mapping[str, str],
clientToken: NotRequired[str],
- See ChangeTypeType
CreateChangesetResponseTypeDef#
# CreateChangesetResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateChangesetResponseTypeDef
def get_value() -> CreateChangesetResponseTypeDef:
return {
"datasetId": ...,
"changesetId": ...,
"ResponseMetadata": ...,
}
# CreateChangesetResponseTypeDef definition
class CreateChangesetResponseTypeDef(TypedDict):
datasetId: str,
changesetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DataViewDestinationTypeParamsTypeDef#
# DataViewDestinationTypeParamsTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DataViewDestinationTypeParamsTypeDef
def get_value() -> DataViewDestinationTypeParamsTypeDef:
return {
"destinationType": ...,
}
# DataViewDestinationTypeParamsTypeDef definition
class DataViewDestinationTypeParamsTypeDef(TypedDict):
destinationType: str,
s3DestinationExportFileFormat: NotRequired[ExportFileFormatType], # (1)
s3DestinationExportFileFormatOptions: NotRequired[Mapping[str, str]],
CreateDataViewResponseTypeDef#
# CreateDataViewResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateDataViewResponseTypeDef
def get_value() -> CreateDataViewResponseTypeDef:
return {
"datasetId": ...,
"dataViewId": ...,
"ResponseMetadata": ...,
}
# CreateDataViewResponseTypeDef definition
class CreateDataViewResponseTypeDef(TypedDict):
datasetId: str,
dataViewId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DatasetOwnerInfoTypeDef#
# DatasetOwnerInfoTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DatasetOwnerInfoTypeDef
def get_value() -> DatasetOwnerInfoTypeDef:
return {
"name": ...,
}
# DatasetOwnerInfoTypeDef definition
class DatasetOwnerInfoTypeDef(TypedDict):
name: NotRequired[str],
phoneNumber: NotRequired[str],
email: NotRequired[str],
CreateDatasetResponseTypeDef#
# CreateDatasetResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateDatasetResponseTypeDef
def get_value() -> CreateDatasetResponseTypeDef:
return {
"datasetId": ...,
"ResponseMetadata": ...,
}
# CreateDatasetResponseTypeDef definition
class CreateDatasetResponseTypeDef(TypedDict):
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePermissionGroupRequestRequestTypeDef#
# CreatePermissionGroupRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreatePermissionGroupRequestRequestTypeDef
def get_value() -> CreatePermissionGroupRequestRequestTypeDef:
return {
"name": ...,
"applicationPermissions": ...,
}
# CreatePermissionGroupRequestRequestTypeDef definition
class CreatePermissionGroupRequestRequestTypeDef(TypedDict):
name: str,
applicationPermissions: Sequence[ApplicationPermissionType], # (1)
description: NotRequired[str],
clientToken: NotRequired[str],
CreatePermissionGroupResponseTypeDef#
# CreatePermissionGroupResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreatePermissionGroupResponseTypeDef
def get_value() -> CreatePermissionGroupResponseTypeDef:
return {
"permissionGroupId": ...,
"ResponseMetadata": ...,
}
# CreatePermissionGroupResponseTypeDef definition
class CreatePermissionGroupResponseTypeDef(TypedDict):
permissionGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserRequestRequestTypeDef#
# CreateUserRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateUserRequestRequestTypeDef
def get_value() -> CreateUserRequestRequestTypeDef:
return {
"emailAddress": ...,
"type": ...,
}
# 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],
- See UserTypeType
- See ApiAccessType
CreateUserResponseTypeDef#
# CreateUserResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateUserResponseTypeDef
def get_value() -> CreateUserResponseTypeDef:
return {
"userId": ...,
"ResponseMetadata": ...,
}
# CreateUserResponseTypeDef definition
class CreateUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CredentialsTypeDef#
# CredentialsTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CredentialsTypeDef
def get_value() -> CredentialsTypeDef:
return {
"accessKeyId": ...,
}
# CredentialsTypeDef definition
class CredentialsTypeDef(TypedDict):
accessKeyId: NotRequired[str],
secretAccessKey: NotRequired[str],
sessionToken: NotRequired[str],
DataViewErrorInfoTypeDef#
# DataViewErrorInfoTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DataViewErrorInfoTypeDef
def get_value() -> DataViewErrorInfoTypeDef:
return {
"errorMessage": ...,
}
# DataViewErrorInfoTypeDef definition
class DataViewErrorInfoTypeDef(TypedDict):
errorMessage: NotRequired[str],
errorCategory: NotRequired[ErrorCategoryType], # (1)
DeleteDatasetRequestRequestTypeDef#
# DeleteDatasetRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DeleteDatasetRequestRequestTypeDef
def get_value() -> DeleteDatasetRequestRequestTypeDef:
return {
"datasetId": ...,
}
# DeleteDatasetRequestRequestTypeDef definition
class DeleteDatasetRequestRequestTypeDef(TypedDict):
datasetId: str,
clientToken: NotRequired[str],
DeleteDatasetResponseTypeDef#
# DeleteDatasetResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DeleteDatasetResponseTypeDef
def get_value() -> DeleteDatasetResponseTypeDef:
return {
"datasetId": ...,
"ResponseMetadata": ...,
}
# DeleteDatasetResponseTypeDef definition
class DeleteDatasetResponseTypeDef(TypedDict):
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeletePermissionGroupRequestRequestTypeDef#
# DeletePermissionGroupRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DeletePermissionGroupRequestRequestTypeDef
def get_value() -> DeletePermissionGroupRequestRequestTypeDef:
return {
"permissionGroupId": ...,
}
# DeletePermissionGroupRequestRequestTypeDef definition
class DeletePermissionGroupRequestRequestTypeDef(TypedDict):
permissionGroupId: str,
clientToken: NotRequired[str],
DeletePermissionGroupResponseTypeDef#
# DeletePermissionGroupResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DeletePermissionGroupResponseTypeDef
def get_value() -> DeletePermissionGroupResponseTypeDef:
return {
"permissionGroupId": ...,
"ResponseMetadata": ...,
}
# DeletePermissionGroupResponseTypeDef definition
class DeletePermissionGroupResponseTypeDef(TypedDict):
permissionGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DisableUserRequestRequestTypeDef#
# DisableUserRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DisableUserRequestRequestTypeDef
def get_value() -> DisableUserRequestRequestTypeDef:
return {
"userId": ...,
}
# DisableUserRequestRequestTypeDef definition
class DisableUserRequestRequestTypeDef(TypedDict):
userId: str,
clientToken: NotRequired[str],
DisableUserResponseTypeDef#
# DisableUserResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DisableUserResponseTypeDef
def get_value() -> DisableUserResponseTypeDef:
return {
"userId": ...,
"ResponseMetadata": ...,
}
# DisableUserResponseTypeDef definition
class DisableUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DisassociateUserFromPermissionGroupRequestRequestTypeDef#
# DisassociateUserFromPermissionGroupRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DisassociateUserFromPermissionGroupRequestRequestTypeDef
def get_value() -> DisassociateUserFromPermissionGroupRequestRequestTypeDef:
return {
"permissionGroupId": ...,
"userId": ...,
}
# DisassociateUserFromPermissionGroupRequestRequestTypeDef definition
class DisassociateUserFromPermissionGroupRequestRequestTypeDef(TypedDict):
permissionGroupId: str,
userId: str,
clientToken: NotRequired[str],
DisassociateUserFromPermissionGroupResponseTypeDef#
# DisassociateUserFromPermissionGroupResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DisassociateUserFromPermissionGroupResponseTypeDef
def get_value() -> DisassociateUserFromPermissionGroupResponseTypeDef:
return {
"statusCode": ...,
"ResponseMetadata": ...,
}
# DisassociateUserFromPermissionGroupResponseTypeDef definition
class DisassociateUserFromPermissionGroupResponseTypeDef(TypedDict):
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EnableUserRequestRequestTypeDef#
# EnableUserRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import EnableUserRequestRequestTypeDef
def get_value() -> EnableUserRequestRequestTypeDef:
return {
"userId": ...,
}
# EnableUserRequestRequestTypeDef definition
class EnableUserRequestRequestTypeDef(TypedDict):
userId: str,
clientToken: NotRequired[str],
EnableUserResponseTypeDef#
# EnableUserResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import EnableUserResponseTypeDef
def get_value() -> EnableUserResponseTypeDef:
return {
"userId": ...,
"ResponseMetadata": ...,
}
# EnableUserResponseTypeDef definition
class EnableUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetChangesetRequestRequestTypeDef#
# GetChangesetRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetChangesetRequestRequestTypeDef
def get_value() -> GetChangesetRequestRequestTypeDef:
return {
"datasetId": ...,
"changesetId": ...,
}
# GetChangesetRequestRequestTypeDef definition
class GetChangesetRequestRequestTypeDef(TypedDict):
datasetId: str,
changesetId: str,
GetDataViewRequestRequestTypeDef#
# GetDataViewRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetDataViewRequestRequestTypeDef
def get_value() -> GetDataViewRequestRequestTypeDef:
return {
"dataViewId": ...,
"datasetId": ...,
}
# GetDataViewRequestRequestTypeDef definition
class GetDataViewRequestRequestTypeDef(TypedDict):
dataViewId: str,
datasetId: str,
GetDatasetRequestRequestTypeDef#
# GetDatasetRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetDatasetRequestRequestTypeDef
def get_value() -> GetDatasetRequestRequestTypeDef:
return {
"datasetId": ...,
}
# GetDatasetRequestRequestTypeDef definition
class GetDatasetRequestRequestTypeDef(TypedDict):
datasetId: str,
GetExternalDataViewAccessDetailsRequestRequestTypeDef#
# GetExternalDataViewAccessDetailsRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetExternalDataViewAccessDetailsRequestRequestTypeDef
def get_value() -> GetExternalDataViewAccessDetailsRequestRequestTypeDef:
return {
"dataViewId": ...,
"datasetId": ...,
}
# GetExternalDataViewAccessDetailsRequestRequestTypeDef definition
class GetExternalDataViewAccessDetailsRequestRequestTypeDef(TypedDict):
dataViewId: str,
datasetId: str,
S3LocationTypeDef#
# S3LocationTypeDef usage example
from mypy_boto3_finspace_data.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"bucket": ...,
"key": ...,
}
# S3LocationTypeDef definition
class S3LocationTypeDef(TypedDict):
bucket: str,
key: str,
GetPermissionGroupRequestRequestTypeDef#
# GetPermissionGroupRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetPermissionGroupRequestRequestTypeDef
def get_value() -> GetPermissionGroupRequestRequestTypeDef:
return {
"permissionGroupId": ...,
}
# GetPermissionGroupRequestRequestTypeDef definition
class GetPermissionGroupRequestRequestTypeDef(TypedDict):
permissionGroupId: str,
PermissionGroupTypeDef#
# PermissionGroupTypeDef usage example
from mypy_boto3_finspace_data.type_defs import PermissionGroupTypeDef
def get_value() -> PermissionGroupTypeDef:
return {
"permissionGroupId": ...,
}
# 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)
GetProgrammaticAccessCredentialsRequestRequestTypeDef#
# GetProgrammaticAccessCredentialsRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetProgrammaticAccessCredentialsRequestRequestTypeDef
def get_value() -> GetProgrammaticAccessCredentialsRequestRequestTypeDef:
return {
"environmentId": ...,
}
# GetProgrammaticAccessCredentialsRequestRequestTypeDef definition
class GetProgrammaticAccessCredentialsRequestRequestTypeDef(TypedDict):
environmentId: str,
durationInMinutes: NotRequired[int],
GetUserRequestRequestTypeDef#
# GetUserRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetUserRequestRequestTypeDef
def get_value() -> GetUserRequestRequestTypeDef:
return {
"userId": ...,
}
# GetUserRequestRequestTypeDef definition
class GetUserRequestRequestTypeDef(TypedDict):
userId: str,
GetUserResponseTypeDef#
# GetUserResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetUserResponseTypeDef
def get_value() -> GetUserResponseTypeDef:
return {
"userId": ...,
"status": ...,
"firstName": ...,
"lastName": ...,
"emailAddress": ...,
"type": ...,
"apiAccess": ...,
"apiAccessPrincipalArn": ...,
"createTime": ...,
"lastEnabledTime": ...,
"lastDisabledTime": ...,
"lastModifiedTime": ...,
"lastLoginTime": ...,
"ResponseMetadata": ...,
}
# 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)
- See UserStatusType
- See UserTypeType
- See ApiAccessType
- See ResponseMetadataTypeDef
GetWorkingLocationRequestRequestTypeDef#
# GetWorkingLocationRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetWorkingLocationRequestRequestTypeDef
def get_value() -> GetWorkingLocationRequestRequestTypeDef:
return {
"locationType": ...,
}
# GetWorkingLocationRequestRequestTypeDef definition
class GetWorkingLocationRequestRequestTypeDef(TypedDict):
locationType: NotRequired[locationTypeType], # (1)
- See locationTypeType
GetWorkingLocationResponseTypeDef#
# GetWorkingLocationResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetWorkingLocationResponseTypeDef
def get_value() -> GetWorkingLocationResponseTypeDef:
return {
"s3Uri": ...,
"s3Path": ...,
"s3Bucket": ...,
"ResponseMetadata": ...,
}
# GetWorkingLocationResponseTypeDef definition
class GetWorkingLocationResponseTypeDef(TypedDict):
s3Uri: str,
s3Path: str,
s3Bucket: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ListChangesetsRequestListChangesetsPaginateTypeDef#
# ListChangesetsRequestListChangesetsPaginateTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListChangesetsRequestListChangesetsPaginateTypeDef
def get_value() -> ListChangesetsRequestListChangesetsPaginateTypeDef:
return {
"datasetId": ...,
}
# ListChangesetsRequestListChangesetsPaginateTypeDef definition
class ListChangesetsRequestListChangesetsPaginateTypeDef(TypedDict):
datasetId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListChangesetsRequestRequestTypeDef#
# ListChangesetsRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListChangesetsRequestRequestTypeDef
def get_value() -> ListChangesetsRequestRequestTypeDef:
return {
"datasetId": ...,
}
# ListChangesetsRequestRequestTypeDef definition
class ListChangesetsRequestRequestTypeDef(TypedDict):
datasetId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDataViewsRequestListDataViewsPaginateTypeDef#
# ListDataViewsRequestListDataViewsPaginateTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListDataViewsRequestListDataViewsPaginateTypeDef
def get_value() -> ListDataViewsRequestListDataViewsPaginateTypeDef:
return {
"datasetId": ...,
}
# ListDataViewsRequestListDataViewsPaginateTypeDef definition
class ListDataViewsRequestListDataViewsPaginateTypeDef(TypedDict):
datasetId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDataViewsRequestRequestTypeDef#
# ListDataViewsRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListDataViewsRequestRequestTypeDef
def get_value() -> ListDataViewsRequestRequestTypeDef:
return {
"datasetId": ...,
}
# ListDataViewsRequestRequestTypeDef definition
class ListDataViewsRequestRequestTypeDef(TypedDict):
datasetId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDatasetsRequestListDatasetsPaginateTypeDef#
# ListDatasetsRequestListDatasetsPaginateTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListDatasetsRequestListDatasetsPaginateTypeDef
def get_value() -> ListDatasetsRequestListDatasetsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListDatasetsRequestListDatasetsPaginateTypeDef definition
class ListDatasetsRequestListDatasetsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatasetsRequestRequestTypeDef#
# ListDatasetsRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListDatasetsRequestRequestTypeDef
def get_value() -> ListDatasetsRequestRequestTypeDef:
return {
"nextToken": ...,
}
# ListDatasetsRequestRequestTypeDef definition
class ListDatasetsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListPermissionGroupsByUserRequestRequestTypeDef#
# ListPermissionGroupsByUserRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsByUserRequestRequestTypeDef
def get_value() -> ListPermissionGroupsByUserRequestRequestTypeDef:
return {
"userId": ...,
"maxResults": ...,
}
# ListPermissionGroupsByUserRequestRequestTypeDef definition
class ListPermissionGroupsByUserRequestRequestTypeDef(TypedDict):
userId: str,
maxResults: int,
nextToken: NotRequired[str],
PermissionGroupByUserTypeDef#
# PermissionGroupByUserTypeDef usage example
from mypy_boto3_finspace_data.type_defs import PermissionGroupByUserTypeDef
def get_value() -> PermissionGroupByUserTypeDef:
return {
"permissionGroupId": ...,
}
# PermissionGroupByUserTypeDef definition
class PermissionGroupByUserTypeDef(TypedDict):
permissionGroupId: NotRequired[str],
name: NotRequired[str],
membershipStatus: NotRequired[PermissionGroupMembershipStatusType], # (1)
ListPermissionGroupsRequestListPermissionGroupsPaginateTypeDef#
# ListPermissionGroupsRequestListPermissionGroupsPaginateTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsRequestListPermissionGroupsPaginateTypeDef
def get_value() -> ListPermissionGroupsRequestListPermissionGroupsPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListPermissionGroupsRequestListPermissionGroupsPaginateTypeDef definition
class ListPermissionGroupsRequestListPermissionGroupsPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPermissionGroupsRequestRequestTypeDef#
# ListPermissionGroupsRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsRequestRequestTypeDef
def get_value() -> ListPermissionGroupsRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListPermissionGroupsRequestRequestTypeDef definition
class ListPermissionGroupsRequestRequestTypeDef(TypedDict):
maxResults: int,
nextToken: NotRequired[str],
ListUsersByPermissionGroupRequestRequestTypeDef#
# ListUsersByPermissionGroupRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListUsersByPermissionGroupRequestRequestTypeDef
def get_value() -> ListUsersByPermissionGroupRequestRequestTypeDef:
return {
"permissionGroupId": ...,
"maxResults": ...,
}
# ListUsersByPermissionGroupRequestRequestTypeDef definition
class ListUsersByPermissionGroupRequestRequestTypeDef(TypedDict):
permissionGroupId: str,
maxResults: int,
nextToken: NotRequired[str],
UserByPermissionGroupTypeDef#
# UserByPermissionGroupTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UserByPermissionGroupTypeDef
def get_value() -> UserByPermissionGroupTypeDef:
return {
"userId": ...,
}
# 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)
- See UserStatusType
- See UserTypeType
- See ApiAccessType
- See PermissionGroupMembershipStatusType
ListUsersRequestListUsersPaginateTypeDef#
# ListUsersRequestListUsersPaginateTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListUsersRequestListUsersPaginateTypeDef
def get_value() -> ListUsersRequestListUsersPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListUsersRequestListUsersPaginateTypeDef definition
class ListUsersRequestListUsersPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsersRequestRequestTypeDef#
# ListUsersRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListUsersRequestRequestTypeDef
def get_value() -> ListUsersRequestRequestTypeDef:
return {
"maxResults": ...,
}
# ListUsersRequestRequestTypeDef definition
class ListUsersRequestRequestTypeDef(TypedDict):
maxResults: int,
nextToken: NotRequired[str],
UserTypeDef#
# UserTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UserTypeDef
def get_value() -> UserTypeDef:
return {
"userId": ...,
}
# 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],
- See UserStatusType
- See UserTypeType
- See ApiAccessType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef usage example
from mypy_boto3_finspace_data.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ResourcePermissionTypeDef#
# ResourcePermissionTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ResourcePermissionTypeDef
def get_value() -> ResourcePermissionTypeDef:
return {
"permission": ...,
}
# ResourcePermissionTypeDef definition
class ResourcePermissionTypeDef(TypedDict):
permission: NotRequired[str],
ResetUserPasswordRequestRequestTypeDef#
# ResetUserPasswordRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ResetUserPasswordRequestRequestTypeDef
def get_value() -> ResetUserPasswordRequestRequestTypeDef:
return {
"userId": ...,
}
# ResetUserPasswordRequestRequestTypeDef definition
class ResetUserPasswordRequestRequestTypeDef(TypedDict):
userId: str,
clientToken: NotRequired[str],
ResetUserPasswordResponseTypeDef#
# ResetUserPasswordResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ResetUserPasswordResponseTypeDef
def get_value() -> ResetUserPasswordResponseTypeDef:
return {
"userId": ...,
"temporaryPassword": ...,
"ResponseMetadata": ...,
}
# ResetUserPasswordResponseTypeDef definition
class ResetUserPasswordResponseTypeDef(TypedDict):
userId: str,
temporaryPassword: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
UpdateChangesetRequestRequestTypeDef#
# UpdateChangesetRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdateChangesetRequestRequestTypeDef
def get_value() -> UpdateChangesetRequestRequestTypeDef:
return {
"datasetId": ...,
"changesetId": ...,
"sourceParams": ...,
"formatParams": ...,
}
# UpdateChangesetRequestRequestTypeDef definition
class UpdateChangesetRequestRequestTypeDef(TypedDict):
datasetId: str,
changesetId: str,
sourceParams: Mapping[str, str],
formatParams: Mapping[str, str],
clientToken: NotRequired[str],
UpdateChangesetResponseTypeDef#
# UpdateChangesetResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdateChangesetResponseTypeDef
def get_value() -> UpdateChangesetResponseTypeDef:
return {
"changesetId": ...,
"datasetId": ...,
"ResponseMetadata": ...,
}
# UpdateChangesetResponseTypeDef definition
class UpdateChangesetResponseTypeDef(TypedDict):
changesetId: str,
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDatasetResponseTypeDef#
# UpdateDatasetResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdateDatasetResponseTypeDef
def get_value() -> UpdateDatasetResponseTypeDef:
return {
"datasetId": ...,
"ResponseMetadata": ...,
}
# UpdateDatasetResponseTypeDef definition
class UpdateDatasetResponseTypeDef(TypedDict):
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdatePermissionGroupRequestRequestTypeDef#
# UpdatePermissionGroupRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdatePermissionGroupRequestRequestTypeDef
def get_value() -> UpdatePermissionGroupRequestRequestTypeDef:
return {
"permissionGroupId": ...,
}
# UpdatePermissionGroupRequestRequestTypeDef definition
class UpdatePermissionGroupRequestRequestTypeDef(TypedDict):
permissionGroupId: str,
name: NotRequired[str],
description: NotRequired[str],
applicationPermissions: NotRequired[Sequence[ApplicationPermissionType]], # (1)
clientToken: NotRequired[str],
UpdatePermissionGroupResponseTypeDef#
# UpdatePermissionGroupResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdatePermissionGroupResponseTypeDef
def get_value() -> UpdatePermissionGroupResponseTypeDef:
return {
"permissionGroupId": ...,
"ResponseMetadata": ...,
}
# UpdatePermissionGroupResponseTypeDef definition
class UpdatePermissionGroupResponseTypeDef(TypedDict):
permissionGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateUserRequestRequestTypeDef#
# UpdateUserRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdateUserRequestRequestTypeDef
def get_value() -> UpdateUserRequestRequestTypeDef:
return {
"userId": ...,
}
# 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],
- See UserTypeType
- See ApiAccessType
UpdateUserResponseTypeDef#
# UpdateUserResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdateUserResponseTypeDef
def get_value() -> UpdateUserResponseTypeDef:
return {
"userId": ...,
"ResponseMetadata": ...,
}
# UpdateUserResponseTypeDef definition
class UpdateUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ChangesetSummaryTypeDef#
# ChangesetSummaryTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ChangesetSummaryTypeDef
def get_value() -> ChangesetSummaryTypeDef:
return {
"changesetId": ...,
}
# ChangesetSummaryTypeDef definition
class ChangesetSummaryTypeDef(TypedDict):
changesetId: NotRequired[str],
changesetArn: NotRequired[str],
datasetId: NotRequired[str],
changeType: NotRequired[ChangeTypeType], # (1)
sourceParams: NotRequired[Dict[str, str]],
formatParams: NotRequired[Dict[str, str]],
createTime: NotRequired[int],
status: NotRequired[IngestionStatusType], # (2)
errorInfo: NotRequired[ChangesetErrorInfoTypeDef], # (3)
activeUntilTimestamp: NotRequired[int],
activeFromTimestamp: NotRequired[int],
updatesChangesetId: NotRequired[str],
updatedByChangesetId: NotRequired[str],
GetChangesetResponseTypeDef#
# GetChangesetResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetChangesetResponseTypeDef
def get_value() -> GetChangesetResponseTypeDef:
return {
"changesetId": ...,
"changesetArn": ...,
"datasetId": ...,
"changeType": ...,
"sourceParams": ...,
"formatParams": ...,
"createTime": ...,
"status": ...,
"errorInfo": ...,
"activeUntilTimestamp": ...,
"activeFromTimestamp": ...,
"updatesChangesetId": ...,
"updatedByChangesetId": ...,
"ResponseMetadata": ...,
}
# GetChangesetResponseTypeDef definition
class GetChangesetResponseTypeDef(TypedDict):
changesetId: str,
changesetArn: str,
datasetId: str,
changeType: ChangeTypeType, # (1)
sourceParams: Dict[str, str],
formatParams: Dict[str, str],
createTime: int,
status: IngestionStatusType, # (2)
errorInfo: ChangesetErrorInfoTypeDef, # (3)
activeUntilTimestamp: int,
activeFromTimestamp: int,
updatesChangesetId: str,
updatedByChangesetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See ChangeTypeType
- See IngestionStatusType
- See ChangesetErrorInfoTypeDef
- See ResponseMetadataTypeDef
SchemaDefinitionTypeDef#
# SchemaDefinitionTypeDef usage example
from mypy_boto3_finspace_data.type_defs import SchemaDefinitionTypeDef
def get_value() -> SchemaDefinitionTypeDef:
return {
"columns": ...,
}
# SchemaDefinitionTypeDef definition
class SchemaDefinitionTypeDef(TypedDict):
columns: NotRequired[Sequence[ColumnDefinitionTypeDef]], # (1)
primaryKeyColumns: NotRequired[Sequence[str]],
CreateDataViewRequestRequestTypeDef#
# CreateDataViewRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateDataViewRequestRequestTypeDef
def get_value() -> CreateDataViewRequestRequestTypeDef:
return {
"datasetId": ...,
"destinationTypeParams": ...,
}
# CreateDataViewRequestRequestTypeDef definition
class CreateDataViewRequestRequestTypeDef(TypedDict):
datasetId: str,
destinationTypeParams: DataViewDestinationTypeParamsTypeDef, # (1)
clientToken: NotRequired[str],
autoUpdate: NotRequired[bool],
sortColumns: NotRequired[Sequence[str]],
partitionColumns: NotRequired[Sequence[str]],
asOfTimestamp: NotRequired[int],
GetProgrammaticAccessCredentialsResponseTypeDef#
# GetProgrammaticAccessCredentialsResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetProgrammaticAccessCredentialsResponseTypeDef
def get_value() -> GetProgrammaticAccessCredentialsResponseTypeDef:
return {
"credentials": ...,
"durationInMinutes": ...,
"ResponseMetadata": ...,
}
# GetProgrammaticAccessCredentialsResponseTypeDef definition
class GetProgrammaticAccessCredentialsResponseTypeDef(TypedDict):
credentials: CredentialsTypeDef, # (1)
durationInMinutes: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DataViewSummaryTypeDef#
# DataViewSummaryTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DataViewSummaryTypeDef
def get_value() -> DataViewSummaryTypeDef:
return {
"dataViewId": ...,
}
# DataViewSummaryTypeDef definition
class DataViewSummaryTypeDef(TypedDict):
dataViewId: NotRequired[str],
dataViewArn: NotRequired[str],
datasetId: NotRequired[str],
asOfTimestamp: NotRequired[int],
partitionColumns: NotRequired[List[str]],
sortColumns: NotRequired[List[str]],
status: NotRequired[DataViewStatusType], # (1)
errorInfo: NotRequired[DataViewErrorInfoTypeDef], # (2)
destinationTypeProperties: NotRequired[DataViewDestinationTypeParamsTypeDef], # (3)
autoUpdate: NotRequired[bool],
createTime: NotRequired[int],
lastModifiedTime: NotRequired[int],
GetDataViewResponseTypeDef#
# GetDataViewResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetDataViewResponseTypeDef
def get_value() -> GetDataViewResponseTypeDef:
return {
"autoUpdate": ...,
"partitionColumns": ...,
"datasetId": ...,
"asOfTimestamp": ...,
"errorInfo": ...,
"lastModifiedTime": ...,
"createTime": ...,
"sortColumns": ...,
"dataViewId": ...,
"dataViewArn": ...,
"destinationTypeParams": ...,
"status": ...,
"ResponseMetadata": ...,
}
# GetDataViewResponseTypeDef definition
class GetDataViewResponseTypeDef(TypedDict):
autoUpdate: bool,
partitionColumns: List[str],
datasetId: str,
asOfTimestamp: int,
errorInfo: DataViewErrorInfoTypeDef, # (1)
lastModifiedTime: int,
createTime: int,
sortColumns: List[str],
dataViewId: str,
dataViewArn: str,
destinationTypeParams: DataViewDestinationTypeParamsTypeDef, # (2)
status: DataViewStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See DataViewErrorInfoTypeDef
- See DataViewDestinationTypeParamsTypeDef
- See DataViewStatusType
- See ResponseMetadataTypeDef
GetExternalDataViewAccessDetailsResponseTypeDef#
# GetExternalDataViewAccessDetailsResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetExternalDataViewAccessDetailsResponseTypeDef
def get_value() -> GetExternalDataViewAccessDetailsResponseTypeDef:
return {
"credentials": ...,
"s3Location": ...,
"ResponseMetadata": ...,
}
# GetExternalDataViewAccessDetailsResponseTypeDef definition
class GetExternalDataViewAccessDetailsResponseTypeDef(TypedDict):
credentials: AwsCredentialsTypeDef, # (1)
s3Location: S3LocationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetPermissionGroupResponseTypeDef#
# GetPermissionGroupResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetPermissionGroupResponseTypeDef
def get_value() -> GetPermissionGroupResponseTypeDef:
return {
"permissionGroup": ...,
"ResponseMetadata": ...,
}
# GetPermissionGroupResponseTypeDef definition
class GetPermissionGroupResponseTypeDef(TypedDict):
permissionGroup: PermissionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPermissionGroupsResponseTypeDef#
# ListPermissionGroupsResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsResponseTypeDef
def get_value() -> ListPermissionGroupsResponseTypeDef:
return {
"permissionGroups": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListPermissionGroupsResponseTypeDef definition
class ListPermissionGroupsResponseTypeDef(TypedDict):
permissionGroups: List[PermissionGroupTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPermissionGroupsByUserResponseTypeDef#
# ListPermissionGroupsByUserResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsByUserResponseTypeDef
def get_value() -> ListPermissionGroupsByUserResponseTypeDef:
return {
"permissionGroups": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListPermissionGroupsByUserResponseTypeDef definition
class ListPermissionGroupsByUserResponseTypeDef(TypedDict):
permissionGroups: List[PermissionGroupByUserTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUsersByPermissionGroupResponseTypeDef#
# ListUsersByPermissionGroupResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListUsersByPermissionGroupResponseTypeDef
def get_value() -> ListUsersByPermissionGroupResponseTypeDef:
return {
"users": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListUsersByPermissionGroupResponseTypeDef definition
class ListUsersByPermissionGroupResponseTypeDef(TypedDict):
users: List[UserByPermissionGroupTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListUsersResponseTypeDef#
# ListUsersResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListUsersResponseTypeDef
def get_value() -> ListUsersResponseTypeDef:
return {
"users": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListUsersResponseTypeDef definition
class ListUsersResponseTypeDef(TypedDict):
users: List[UserTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See UserTypeDef
- See ResponseMetadataTypeDef
PermissionGroupParamsTypeDef#
# PermissionGroupParamsTypeDef usage example
from mypy_boto3_finspace_data.type_defs import PermissionGroupParamsTypeDef
def get_value() -> PermissionGroupParamsTypeDef:
return {
"permissionGroupId": ...,
}
# PermissionGroupParamsTypeDef definition
class PermissionGroupParamsTypeDef(TypedDict):
permissionGroupId: NotRequired[str],
datasetPermissions: NotRequired[Sequence[ResourcePermissionTypeDef]], # (1)
ListChangesetsResponseTypeDef#
# ListChangesetsResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListChangesetsResponseTypeDef
def get_value() -> ListChangesetsResponseTypeDef:
return {
"changesets": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListChangesetsResponseTypeDef definition
class ListChangesetsResponseTypeDef(TypedDict):
changesets: List[ChangesetSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
SchemaUnionTypeDef#
# SchemaUnionTypeDef usage example
from mypy_boto3_finspace_data.type_defs import SchemaUnionTypeDef
def get_value() -> SchemaUnionTypeDef:
return {
"tabularSchemaConfig": ...,
}
# SchemaUnionTypeDef definition
class SchemaUnionTypeDef(TypedDict):
tabularSchemaConfig: NotRequired[SchemaDefinitionTypeDef], # (1)
ListDataViewsResponseTypeDef#
# ListDataViewsResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListDataViewsResponseTypeDef
def get_value() -> ListDataViewsResponseTypeDef:
return {
"nextToken": ...,
"dataViews": ...,
"ResponseMetadata": ...,
}
# ListDataViewsResponseTypeDef definition
class ListDataViewsResponseTypeDef(TypedDict):
nextToken: str,
dataViews: List[DataViewSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateDatasetRequestRequestTypeDef#
# CreateDatasetRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import CreateDatasetRequestRequestTypeDef
def get_value() -> CreateDatasetRequestRequestTypeDef:
return {
"datasetTitle": ...,
"kind": ...,
"permissionGroupParams": ...,
}
# CreateDatasetRequestRequestTypeDef definition
class CreateDatasetRequestRequestTypeDef(TypedDict):
datasetTitle: str,
kind: DatasetKindType, # (1)
permissionGroupParams: PermissionGroupParamsTypeDef, # (2)
clientToken: NotRequired[str],
datasetDescription: NotRequired[str],
ownerInfo: NotRequired[DatasetOwnerInfoTypeDef], # (3)
alias: NotRequired[str],
schemaDefinition: NotRequired[SchemaUnionTypeDef], # (4)
- See DatasetKindType
- See PermissionGroupParamsTypeDef
- See DatasetOwnerInfoTypeDef
- See SchemaUnionTypeDef
DatasetTypeDef#
# DatasetTypeDef usage example
from mypy_boto3_finspace_data.type_defs import DatasetTypeDef
def get_value() -> DatasetTypeDef:
return {
"datasetId": ...,
}
# DatasetTypeDef definition
class DatasetTypeDef(TypedDict):
datasetId: NotRequired[str],
datasetArn: NotRequired[str],
datasetTitle: NotRequired[str],
kind: NotRequired[DatasetKindType], # (1)
datasetDescription: NotRequired[str],
ownerInfo: NotRequired[DatasetOwnerInfoTypeDef], # (2)
createTime: NotRequired[int],
lastModifiedTime: NotRequired[int],
schemaDefinition: NotRequired[SchemaUnionTypeDef], # (3)
alias: NotRequired[str],
- See DatasetKindType
- See DatasetOwnerInfoTypeDef
- See SchemaUnionTypeDef
GetDatasetResponseTypeDef#
# GetDatasetResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import GetDatasetResponseTypeDef
def get_value() -> GetDatasetResponseTypeDef:
return {
"datasetId": ...,
"datasetArn": ...,
"datasetTitle": ...,
"kind": ...,
"datasetDescription": ...,
"createTime": ...,
"lastModifiedTime": ...,
"schemaDefinition": ...,
"alias": ...,
"status": ...,
"ResponseMetadata": ...,
}
# GetDatasetResponseTypeDef definition
class GetDatasetResponseTypeDef(TypedDict):
datasetId: str,
datasetArn: str,
datasetTitle: str,
kind: DatasetKindType, # (1)
datasetDescription: str,
createTime: int,
lastModifiedTime: int,
schemaDefinition: SchemaUnionTypeDef, # (2)
alias: str,
status: DatasetStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See DatasetKindType
- See SchemaUnionTypeDef
- See DatasetStatusType
- See ResponseMetadataTypeDef
UpdateDatasetRequestRequestTypeDef#
# UpdateDatasetRequestRequestTypeDef usage example
from mypy_boto3_finspace_data.type_defs import UpdateDatasetRequestRequestTypeDef
def get_value() -> UpdateDatasetRequestRequestTypeDef:
return {
"datasetId": ...,
"datasetTitle": ...,
"kind": ...,
}
# UpdateDatasetRequestRequestTypeDef definition
class UpdateDatasetRequestRequestTypeDef(TypedDict):
datasetId: str,
datasetTitle: str,
kind: DatasetKindType, # (1)
clientToken: NotRequired[str],
datasetDescription: NotRequired[str],
alias: NotRequired[str],
schemaDefinition: NotRequired[SchemaUnionTypeDef], # (2)
- See DatasetKindType
- See SchemaUnionTypeDef
ListDatasetsResponseTypeDef#
# ListDatasetsResponseTypeDef usage example
from mypy_boto3_finspace_data.type_defs import ListDatasetsResponseTypeDef
def get_value() -> ListDatasetsResponseTypeDef:
return {
"datasets": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListDatasetsResponseTypeDef definition
class ListDatasetsResponseTypeDef(TypedDict):
datasets: List[DatasetTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)