Type definitions#
Index > FinSpaceData > Type definitions
Auto-generated documentation for FinSpaceData type annotations stubs module mypy-boto3-finspace-data.
DataViewDestinationTypeParamsUnionTypeDef#
# DataViewDestinationTypeParamsUnionTypeDef Union usage example
from mypy_boto3_finspace_data.type_defs import DataViewDestinationTypeParamsUnionTypeDef
def get_value() -> DataViewDestinationTypeParamsUnionTypeDef:
return ...
# DataViewDestinationTypeParamsUnionTypeDef definition
DataViewDestinationTypeParamsUnionTypeDef = Union[
DataViewDestinationTypeParamsTypeDef, # (1)
DataViewDestinationTypeParamsOutputTypeDef, # (2)
]
SchemaUnionUnionTypeDef#
# SchemaUnionUnionTypeDef Union usage example
from mypy_boto3_finspace_data.type_defs import SchemaUnionUnionTypeDef
def get_value() -> SchemaUnionUnionTypeDef:
return ...
# SchemaUnionUnionTypeDef definition
SchemaUnionUnionTypeDef = Union[
SchemaUnionTypeDef, # (1)
SchemaUnionOutputTypeDef, # (2)
]
AssociateUserToPermissionGroupRequestTypeDef#
# AssociateUserToPermissionGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import AssociateUserToPermissionGroupRequestTypeDef
def get_value() -> AssociateUserToPermissionGroupRequestTypeDef:
return {
"permissionGroupId": ...,
}
# AssociateUserToPermissionGroupRequestTypeDef definition
class AssociateUserToPermissionGroupRequestTypeDef(TypedDict):
permissionGroupId: str,
userId: str,
clientToken: NotRequired[str],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
AwsCredentialsTypeDef#
# AwsCredentialsTypeDef TypedDict 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 TypedDict 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 TypedDict 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],
CreateChangesetRequestTypeDef#
# CreateChangesetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateChangesetRequestTypeDef
def get_value() -> CreateChangesetRequestTypeDef:
return {
"datasetId": ...,
}
# CreateChangesetRequestTypeDef definition
class CreateChangesetRequestTypeDef(TypedDict):
datasetId: str,
changeType: ChangeTypeType, # (1)
sourceParams: Mapping[str, str],
formatParams: Mapping[str, str],
clientToken: NotRequired[str],
- See ChangeTypeType
DatasetOwnerInfoTypeDef#
# DatasetOwnerInfoTypeDef TypedDict 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],
CreatePermissionGroupRequestTypeDef#
# CreatePermissionGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreatePermissionGroupRequestTypeDef
def get_value() -> CreatePermissionGroupRequestTypeDef:
return {
"name": ...,
}
# CreatePermissionGroupRequestTypeDef definition
class CreatePermissionGroupRequestTypeDef(TypedDict):
name: str,
applicationPermissions: Sequence[ApplicationPermissionType], # (1)
description: NotRequired[str],
clientToken: NotRequired[str],
- See
Sequence[ApplicationPermissionType]
CreateUserRequestTypeDef#
# CreateUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateUserRequestTypeDef
def get_value() -> CreateUserRequestTypeDef:
return {
"emailAddress": ...,
}
# CreateUserRequestTypeDef definition
class CreateUserRequestTypeDef(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
CredentialsTypeDef#
# CredentialsTypeDef TypedDict 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],
DataViewDestinationTypeParamsOutputTypeDef#
# DataViewDestinationTypeParamsOutputTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DataViewDestinationTypeParamsOutputTypeDef
def get_value() -> DataViewDestinationTypeParamsOutputTypeDef:
return {
"destinationType": ...,
}
# DataViewDestinationTypeParamsOutputTypeDef definition
class DataViewDestinationTypeParamsOutputTypeDef(TypedDict):
destinationType: str,
s3DestinationExportFileFormat: NotRequired[ExportFileFormatType], # (1)
s3DestinationExportFileFormatOptions: NotRequired[Dict[str, str]],
DataViewDestinationTypeParamsTypeDef#
# DataViewDestinationTypeParamsTypeDef TypedDict 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]],
DataViewErrorInfoTypeDef#
# DataViewErrorInfoTypeDef TypedDict 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)
DeleteDatasetRequestTypeDef#
# DeleteDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DeleteDatasetRequestTypeDef
def get_value() -> DeleteDatasetRequestTypeDef:
return {
"datasetId": ...,
}
# DeleteDatasetRequestTypeDef definition
class DeleteDatasetRequestTypeDef(TypedDict):
datasetId: str,
clientToken: NotRequired[str],
DeletePermissionGroupRequestTypeDef#
# DeletePermissionGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DeletePermissionGroupRequestTypeDef
def get_value() -> DeletePermissionGroupRequestTypeDef:
return {
"permissionGroupId": ...,
}
# DeletePermissionGroupRequestTypeDef definition
class DeletePermissionGroupRequestTypeDef(TypedDict):
permissionGroupId: str,
clientToken: NotRequired[str],
DisableUserRequestTypeDef#
# DisableUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DisableUserRequestTypeDef
def get_value() -> DisableUserRequestTypeDef:
return {
"userId": ...,
}
# DisableUserRequestTypeDef definition
class DisableUserRequestTypeDef(TypedDict):
userId: str,
clientToken: NotRequired[str],
DisassociateUserFromPermissionGroupRequestTypeDef#
# DisassociateUserFromPermissionGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DisassociateUserFromPermissionGroupRequestTypeDef
def get_value() -> DisassociateUserFromPermissionGroupRequestTypeDef:
return {
"permissionGroupId": ...,
}
# DisassociateUserFromPermissionGroupRequestTypeDef definition
class DisassociateUserFromPermissionGroupRequestTypeDef(TypedDict):
permissionGroupId: str,
userId: str,
clientToken: NotRequired[str],
EnableUserRequestTypeDef#
# EnableUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import EnableUserRequestTypeDef
def get_value() -> EnableUserRequestTypeDef:
return {
"userId": ...,
}
# EnableUserRequestTypeDef definition
class EnableUserRequestTypeDef(TypedDict):
userId: str,
clientToken: NotRequired[str],
GetChangesetRequestTypeDef#
# GetChangesetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetChangesetRequestTypeDef
def get_value() -> GetChangesetRequestTypeDef:
return {
"datasetId": ...,
}
# GetChangesetRequestTypeDef definition
class GetChangesetRequestTypeDef(TypedDict):
datasetId: str,
changesetId: str,
GetDataViewRequestTypeDef#
# GetDataViewRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetDataViewRequestTypeDef
def get_value() -> GetDataViewRequestTypeDef:
return {
"dataViewId": ...,
}
# GetDataViewRequestTypeDef definition
class GetDataViewRequestTypeDef(TypedDict):
dataViewId: str,
datasetId: str,
GetDatasetRequestTypeDef#
# GetDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetDatasetRequestTypeDef
def get_value() -> GetDatasetRequestTypeDef:
return {
"datasetId": ...,
}
# GetDatasetRequestTypeDef definition
class GetDatasetRequestTypeDef(TypedDict):
datasetId: str,
GetExternalDataViewAccessDetailsRequestTypeDef#
# GetExternalDataViewAccessDetailsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetExternalDataViewAccessDetailsRequestTypeDef
def get_value() -> GetExternalDataViewAccessDetailsRequestTypeDef:
return {
"dataViewId": ...,
}
# GetExternalDataViewAccessDetailsRequestTypeDef definition
class GetExternalDataViewAccessDetailsRequestTypeDef(TypedDict):
dataViewId: str,
datasetId: str,
S3LocationTypeDef#
# S3LocationTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import S3LocationTypeDef
def get_value() -> S3LocationTypeDef:
return {
"bucket": ...,
}
# S3LocationTypeDef definition
class S3LocationTypeDef(TypedDict):
bucket: str,
key: str,
GetPermissionGroupRequestTypeDef#
# GetPermissionGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetPermissionGroupRequestTypeDef
def get_value() -> GetPermissionGroupRequestTypeDef:
return {
"permissionGroupId": ...,
}
# GetPermissionGroupRequestTypeDef definition
class GetPermissionGroupRequestTypeDef(TypedDict):
permissionGroupId: str,
PermissionGroupTypeDef#
# PermissionGroupTypeDef TypedDict 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)
- See
List[ApplicationPermissionType]
- See PermissionGroupMembershipStatusType
GetProgrammaticAccessCredentialsRequestTypeDef#
# GetProgrammaticAccessCredentialsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetProgrammaticAccessCredentialsRequestTypeDef
def get_value() -> GetProgrammaticAccessCredentialsRequestTypeDef:
return {
"environmentId": ...,
}
# GetProgrammaticAccessCredentialsRequestTypeDef definition
class GetProgrammaticAccessCredentialsRequestTypeDef(TypedDict):
environmentId: str,
durationInMinutes: NotRequired[int],
GetUserRequestTypeDef#
# GetUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetUserRequestTypeDef
def get_value() -> GetUserRequestTypeDef:
return {
"userId": ...,
}
# GetUserRequestTypeDef definition
class GetUserRequestTypeDef(TypedDict):
userId: str,
GetWorkingLocationRequestTypeDef#
# GetWorkingLocationRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetWorkingLocationRequestTypeDef
def get_value() -> GetWorkingLocationRequestTypeDef:
return {
"locationType": ...,
}
# GetWorkingLocationRequestTypeDef definition
class GetWorkingLocationRequestTypeDef(TypedDict):
locationType: NotRequired[LocationTypeType], # (1)
- See LocationTypeType
PaginatorConfigTypeDef#
# PaginatorConfigTypeDef TypedDict 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],
ListChangesetsRequestTypeDef#
# ListChangesetsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListChangesetsRequestTypeDef
def get_value() -> ListChangesetsRequestTypeDef:
return {
"datasetId": ...,
}
# ListChangesetsRequestTypeDef definition
class ListChangesetsRequestTypeDef(TypedDict):
datasetId: str,
maxResults: NotRequired[int],
nextToken: NotRequired[str],
ListDataViewsRequestTypeDef#
# ListDataViewsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListDataViewsRequestTypeDef
def get_value() -> ListDataViewsRequestTypeDef:
return {
"datasetId": ...,
}
# ListDataViewsRequestTypeDef definition
class ListDataViewsRequestTypeDef(TypedDict):
datasetId: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDatasetsRequestTypeDef#
# ListDatasetsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListDatasetsRequestTypeDef
def get_value() -> ListDatasetsRequestTypeDef:
return {
"nextToken": ...,
}
# ListDatasetsRequestTypeDef definition
class ListDatasetsRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListPermissionGroupsByUserRequestTypeDef#
# ListPermissionGroupsByUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsByUserRequestTypeDef
def get_value() -> ListPermissionGroupsByUserRequestTypeDef:
return {
"userId": ...,
}
# ListPermissionGroupsByUserRequestTypeDef definition
class ListPermissionGroupsByUserRequestTypeDef(TypedDict):
userId: str,
maxResults: int,
nextToken: NotRequired[str],
PermissionGroupByUserTypeDef#
# PermissionGroupByUserTypeDef TypedDict 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)
ListPermissionGroupsRequestTypeDef#
# ListPermissionGroupsRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsRequestTypeDef
def get_value() -> ListPermissionGroupsRequestTypeDef:
return {
"maxResults": ...,
}
# ListPermissionGroupsRequestTypeDef definition
class ListPermissionGroupsRequestTypeDef(TypedDict):
maxResults: int,
nextToken: NotRequired[str],
ListUsersByPermissionGroupRequestTypeDef#
# ListUsersByPermissionGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListUsersByPermissionGroupRequestTypeDef
def get_value() -> ListUsersByPermissionGroupRequestTypeDef:
return {
"permissionGroupId": ...,
}
# ListUsersByPermissionGroupRequestTypeDef definition
class ListUsersByPermissionGroupRequestTypeDef(TypedDict):
permissionGroupId: str,
maxResults: int,
nextToken: NotRequired[str],
UserByPermissionGroupTypeDef#
# UserByPermissionGroupTypeDef TypedDict 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
ListUsersRequestTypeDef#
# ListUsersRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListUsersRequestTypeDef
def get_value() -> ListUsersRequestTypeDef:
return {
"maxResults": ...,
}
# ListUsersRequestTypeDef definition
class ListUsersRequestTypeDef(TypedDict):
maxResults: int,
nextToken: NotRequired[str],
UserTypeDef#
# UserTypeDef TypedDict 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
ResourcePermissionTypeDef#
# ResourcePermissionTypeDef TypedDict 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],
ResetUserPasswordRequestTypeDef#
# ResetUserPasswordRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ResetUserPasswordRequestTypeDef
def get_value() -> ResetUserPasswordRequestTypeDef:
return {
"userId": ...,
}
# ResetUserPasswordRequestTypeDef definition
class ResetUserPasswordRequestTypeDef(TypedDict):
userId: str,
clientToken: NotRequired[str],
UpdateChangesetRequestTypeDef#
# UpdateChangesetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdateChangesetRequestTypeDef
def get_value() -> UpdateChangesetRequestTypeDef:
return {
"datasetId": ...,
}
# UpdateChangesetRequestTypeDef definition
class UpdateChangesetRequestTypeDef(TypedDict):
datasetId: str,
changesetId: str,
sourceParams: Mapping[str, str],
formatParams: Mapping[str, str],
clientToken: NotRequired[str],
UpdatePermissionGroupRequestTypeDef#
# UpdatePermissionGroupRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdatePermissionGroupRequestTypeDef
def get_value() -> UpdatePermissionGroupRequestTypeDef:
return {
"permissionGroupId": ...,
}
# UpdatePermissionGroupRequestTypeDef definition
class UpdatePermissionGroupRequestTypeDef(TypedDict):
permissionGroupId: str,
name: NotRequired[str],
description: NotRequired[str],
applicationPermissions: NotRequired[Sequence[ApplicationPermissionType]], # (1)
clientToken: NotRequired[str],
- See
Sequence[ApplicationPermissionType]
UpdateUserRequestTypeDef#
# UpdateUserRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdateUserRequestTypeDef
def get_value() -> UpdateUserRequestTypeDef:
return {
"userId": ...,
}
# UpdateUserRequestTypeDef definition
class UpdateUserRequestTypeDef(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
AssociateUserToPermissionGroupResponseTypeDef#
# AssociateUserToPermissionGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import AssociateUserToPermissionGroupResponseTypeDef
def get_value() -> AssociateUserToPermissionGroupResponseTypeDef:
return {
"statusCode": ...,
}
# AssociateUserToPermissionGroupResponseTypeDef definition
class AssociateUserToPermissionGroupResponseTypeDef(TypedDict):
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateChangesetResponseTypeDef#
# CreateChangesetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateChangesetResponseTypeDef
def get_value() -> CreateChangesetResponseTypeDef:
return {
"datasetId": ...,
}
# CreateChangesetResponseTypeDef definition
class CreateChangesetResponseTypeDef(TypedDict):
datasetId: str,
changesetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDataViewResponseTypeDef#
# CreateDataViewResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateDataViewResponseTypeDef
def get_value() -> CreateDataViewResponseTypeDef:
return {
"datasetId": ...,
}
# CreateDataViewResponseTypeDef definition
class CreateDataViewResponseTypeDef(TypedDict):
datasetId: str,
dataViewId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateDatasetResponseTypeDef#
# CreateDatasetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateDatasetResponseTypeDef
def get_value() -> CreateDatasetResponseTypeDef:
return {
"datasetId": ...,
}
# CreateDatasetResponseTypeDef definition
class CreateDatasetResponseTypeDef(TypedDict):
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreatePermissionGroupResponseTypeDef#
# CreatePermissionGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreatePermissionGroupResponseTypeDef
def get_value() -> CreatePermissionGroupResponseTypeDef:
return {
"permissionGroupId": ...,
}
# CreatePermissionGroupResponseTypeDef definition
class CreatePermissionGroupResponseTypeDef(TypedDict):
permissionGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateUserResponseTypeDef#
# CreateUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateUserResponseTypeDef
def get_value() -> CreateUserResponseTypeDef:
return {
"userId": ...,
}
# CreateUserResponseTypeDef definition
class CreateUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeleteDatasetResponseTypeDef#
# DeleteDatasetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DeleteDatasetResponseTypeDef
def get_value() -> DeleteDatasetResponseTypeDef:
return {
"datasetId": ...,
}
# DeleteDatasetResponseTypeDef definition
class DeleteDatasetResponseTypeDef(TypedDict):
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DeletePermissionGroupResponseTypeDef#
# DeletePermissionGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DeletePermissionGroupResponseTypeDef
def get_value() -> DeletePermissionGroupResponseTypeDef:
return {
"permissionGroupId": ...,
}
# DeletePermissionGroupResponseTypeDef definition
class DeletePermissionGroupResponseTypeDef(TypedDict):
permissionGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DisableUserResponseTypeDef#
# DisableUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DisableUserResponseTypeDef
def get_value() -> DisableUserResponseTypeDef:
return {
"userId": ...,
}
# DisableUserResponseTypeDef definition
class DisableUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
DisassociateUserFromPermissionGroupResponseTypeDef#
# DisassociateUserFromPermissionGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import DisassociateUserFromPermissionGroupResponseTypeDef
def get_value() -> DisassociateUserFromPermissionGroupResponseTypeDef:
return {
"statusCode": ...,
}
# DisassociateUserFromPermissionGroupResponseTypeDef definition
class DisassociateUserFromPermissionGroupResponseTypeDef(TypedDict):
statusCode: int,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
EnableUserResponseTypeDef#
# EnableUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import EnableUserResponseTypeDef
def get_value() -> EnableUserResponseTypeDef:
return {
"userId": ...,
}
# EnableUserResponseTypeDef definition
class EnableUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
GetUserResponseTypeDef#
# GetUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetUserResponseTypeDef
def get_value() -> GetUserResponseTypeDef:
return {
"userId": ...,
}
# 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
GetWorkingLocationResponseTypeDef#
# GetWorkingLocationResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetWorkingLocationResponseTypeDef
def get_value() -> GetWorkingLocationResponseTypeDef:
return {
"s3Uri": ...,
}
# GetWorkingLocationResponseTypeDef definition
class GetWorkingLocationResponseTypeDef(TypedDict):
s3Uri: str,
s3Path: str,
s3Bucket: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ResetUserPasswordResponseTypeDef#
# ResetUserPasswordResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ResetUserPasswordResponseTypeDef
def get_value() -> ResetUserPasswordResponseTypeDef:
return {
"userId": ...,
}
# ResetUserPasswordResponseTypeDef definition
class ResetUserPasswordResponseTypeDef(TypedDict):
userId: str,
temporaryPassword: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateChangesetResponseTypeDef#
# UpdateChangesetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdateChangesetResponseTypeDef
def get_value() -> UpdateChangesetResponseTypeDef:
return {
"changesetId": ...,
}
# UpdateChangesetResponseTypeDef definition
class UpdateChangesetResponseTypeDef(TypedDict):
changesetId: str,
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateDatasetResponseTypeDef#
# UpdateDatasetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdateDatasetResponseTypeDef
def get_value() -> UpdateDatasetResponseTypeDef:
return {
"datasetId": ...,
}
# UpdateDatasetResponseTypeDef definition
class UpdateDatasetResponseTypeDef(TypedDict):
datasetId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdatePermissionGroupResponseTypeDef#
# UpdatePermissionGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdatePermissionGroupResponseTypeDef
def get_value() -> UpdatePermissionGroupResponseTypeDef:
return {
"permissionGroupId": ...,
}
# UpdatePermissionGroupResponseTypeDef definition
class UpdatePermissionGroupResponseTypeDef(TypedDict):
permissionGroupId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
UpdateUserResponseTypeDef#
# UpdateUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdateUserResponseTypeDef
def get_value() -> UpdateUserResponseTypeDef:
return {
"userId": ...,
}
# UpdateUserResponseTypeDef definition
class UpdateUserResponseTypeDef(TypedDict):
userId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
ChangesetSummaryTypeDef#
# ChangesetSummaryTypeDef TypedDict 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 TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetChangesetResponseTypeDef
def get_value() -> GetChangesetResponseTypeDef:
return {
"changesetId": ...,
}
# 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
SchemaDefinitionOutputTypeDef#
# SchemaDefinitionOutputTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import SchemaDefinitionOutputTypeDef
def get_value() -> SchemaDefinitionOutputTypeDef:
return {
"columns": ...,
}
# SchemaDefinitionOutputTypeDef definition
class SchemaDefinitionOutputTypeDef(TypedDict):
columns: NotRequired[List[ColumnDefinitionTypeDef]], # (1)
primaryKeyColumns: NotRequired[List[str]],
- See
List[ColumnDefinitionTypeDef]
SchemaDefinitionTypeDef#
# SchemaDefinitionTypeDef TypedDict 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]],
- See
Sequence[ColumnDefinitionTypeDef]
GetProgrammaticAccessCredentialsResponseTypeDef#
# GetProgrammaticAccessCredentialsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetProgrammaticAccessCredentialsResponseTypeDef
def get_value() -> GetProgrammaticAccessCredentialsResponseTypeDef:
return {
"credentials": ...,
}
# GetProgrammaticAccessCredentialsResponseTypeDef definition
class GetProgrammaticAccessCredentialsResponseTypeDef(TypedDict):
credentials: CredentialsTypeDef, # (1)
durationInMinutes: int,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
DataViewSummaryTypeDef#
# DataViewSummaryTypeDef TypedDict 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[DataViewDestinationTypeParamsOutputTypeDef], # (3)
autoUpdate: NotRequired[bool],
createTime: NotRequired[int],
lastModifiedTime: NotRequired[int],
GetDataViewResponseTypeDef#
# GetDataViewResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetDataViewResponseTypeDef
def get_value() -> GetDataViewResponseTypeDef:
return {
"autoUpdate": ...,
}
# 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: DataViewDestinationTypeParamsOutputTypeDef, # (2)
status: DataViewStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
- See DataViewErrorInfoTypeDef
- See DataViewDestinationTypeParamsOutputTypeDef
- See DataViewStatusType
- See ResponseMetadataTypeDef
GetExternalDataViewAccessDetailsResponseTypeDef#
# GetExternalDataViewAccessDetailsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetExternalDataViewAccessDetailsResponseTypeDef
def get_value() -> GetExternalDataViewAccessDetailsResponseTypeDef:
return {
"credentials": ...,
}
# GetExternalDataViewAccessDetailsResponseTypeDef definition
class GetExternalDataViewAccessDetailsResponseTypeDef(TypedDict):
credentials: AwsCredentialsTypeDef, # (1)
s3Location: S3LocationTypeDef, # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetPermissionGroupResponseTypeDef#
# GetPermissionGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetPermissionGroupResponseTypeDef
def get_value() -> GetPermissionGroupResponseTypeDef:
return {
"permissionGroup": ...,
}
# GetPermissionGroupResponseTypeDef definition
class GetPermissionGroupResponseTypeDef(TypedDict):
permissionGroup: PermissionGroupTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListPermissionGroupsResponseTypeDef#
# ListPermissionGroupsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsResponseTypeDef
def get_value() -> ListPermissionGroupsResponseTypeDef:
return {
"permissionGroups": ...,
}
# ListPermissionGroupsResponseTypeDef definition
class ListPermissionGroupsResponseTypeDef(TypedDict):
permissionGroups: List[PermissionGroupTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[PermissionGroupTypeDef]
- See ResponseMetadataTypeDef
ListChangesetsRequestPaginateTypeDef#
# ListChangesetsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListChangesetsRequestPaginateTypeDef
def get_value() -> ListChangesetsRequestPaginateTypeDef:
return {
"datasetId": ...,
}
# ListChangesetsRequestPaginateTypeDef definition
class ListChangesetsRequestPaginateTypeDef(TypedDict):
datasetId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDataViewsRequestPaginateTypeDef#
# ListDataViewsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListDataViewsRequestPaginateTypeDef
def get_value() -> ListDataViewsRequestPaginateTypeDef:
return {
"datasetId": ...,
}
# ListDataViewsRequestPaginateTypeDef definition
class ListDataViewsRequestPaginateTypeDef(TypedDict):
datasetId: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListDatasetsRequestPaginateTypeDef#
# ListDatasetsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListDatasetsRequestPaginateTypeDef
def get_value() -> ListDatasetsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListDatasetsRequestPaginateTypeDef definition
class ListDatasetsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPermissionGroupsRequestPaginateTypeDef#
# ListPermissionGroupsRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsRequestPaginateTypeDef
def get_value() -> ListPermissionGroupsRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListPermissionGroupsRequestPaginateTypeDef definition
class ListPermissionGroupsRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListUsersRequestPaginateTypeDef#
# ListUsersRequestPaginateTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListUsersRequestPaginateTypeDef
def get_value() -> ListUsersRequestPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListUsersRequestPaginateTypeDef definition
class ListUsersRequestPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListPermissionGroupsByUserResponseTypeDef#
# ListPermissionGroupsByUserResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListPermissionGroupsByUserResponseTypeDef
def get_value() -> ListPermissionGroupsByUserResponseTypeDef:
return {
"permissionGroups": ...,
}
# ListPermissionGroupsByUserResponseTypeDef definition
class ListPermissionGroupsByUserResponseTypeDef(TypedDict):
permissionGroups: List[PermissionGroupByUserTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[PermissionGroupByUserTypeDef]
- See ResponseMetadataTypeDef
ListUsersByPermissionGroupResponseTypeDef#
# ListUsersByPermissionGroupResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListUsersByPermissionGroupResponseTypeDef
def get_value() -> ListUsersByPermissionGroupResponseTypeDef:
return {
"users": ...,
}
# ListUsersByPermissionGroupResponseTypeDef definition
class ListUsersByPermissionGroupResponseTypeDef(TypedDict):
users: List[UserByPermissionGroupTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[UserByPermissionGroupTypeDef]
- See ResponseMetadataTypeDef
ListUsersResponseTypeDef#
# ListUsersResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListUsersResponseTypeDef
def get_value() -> ListUsersResponseTypeDef:
return {
"users": ...,
}
# ListUsersResponseTypeDef definition
class ListUsersResponseTypeDef(TypedDict):
users: List[UserTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[UserTypeDef]
- See ResponseMetadataTypeDef
PermissionGroupParamsTypeDef#
# PermissionGroupParamsTypeDef TypedDict 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)
- See
Sequence[ResourcePermissionTypeDef]
ListChangesetsResponseTypeDef#
# ListChangesetsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListChangesetsResponseTypeDef
def get_value() -> ListChangesetsResponseTypeDef:
return {
"changesets": ...,
}
# ListChangesetsResponseTypeDef definition
class ListChangesetsResponseTypeDef(TypedDict):
changesets: List[ChangesetSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[ChangesetSummaryTypeDef]
- See ResponseMetadataTypeDef
SchemaUnionOutputTypeDef#
# SchemaUnionOutputTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import SchemaUnionOutputTypeDef
def get_value() -> SchemaUnionOutputTypeDef:
return {
"tabularSchemaConfig": ...,
}
# SchemaUnionOutputTypeDef definition
class SchemaUnionOutputTypeDef(TypedDict):
tabularSchemaConfig: NotRequired[SchemaDefinitionOutputTypeDef], # (1)
SchemaUnionTypeDef#
# SchemaUnionTypeDef TypedDict 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)
CreateDataViewRequestTypeDef#
# CreateDataViewRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateDataViewRequestTypeDef
def get_value() -> CreateDataViewRequestTypeDef:
return {
"datasetId": ...,
}
# CreateDataViewRequestTypeDef definition
class CreateDataViewRequestTypeDef(TypedDict):
datasetId: str,
destinationTypeParams: DataViewDestinationTypeParamsUnionTypeDef, # (1)
clientToken: NotRequired[str],
autoUpdate: NotRequired[bool],
sortColumns: NotRequired[Sequence[str]],
partitionColumns: NotRequired[Sequence[str]],
asOfTimestamp: NotRequired[int],
ListDataViewsResponseTypeDef#
# ListDataViewsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListDataViewsResponseTypeDef
def get_value() -> ListDataViewsResponseTypeDef:
return {
"nextToken": ...,
}
# ListDataViewsResponseTypeDef definition
class ListDataViewsResponseTypeDef(TypedDict):
dataViews: List[DataViewSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[DataViewSummaryTypeDef]
- See ResponseMetadataTypeDef
DatasetTypeDef#
# DatasetTypeDef TypedDict 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[SchemaUnionOutputTypeDef], # (3)
alias: NotRequired[str],
GetDatasetResponseTypeDef#
# GetDatasetResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import GetDatasetResponseTypeDef
def get_value() -> GetDatasetResponseTypeDef:
return {
"datasetId": ...,
}
# GetDatasetResponseTypeDef definition
class GetDatasetResponseTypeDef(TypedDict):
datasetId: str,
datasetArn: str,
datasetTitle: str,
kind: DatasetKindType, # (1)
datasetDescription: str,
createTime: int,
lastModifiedTime: int,
schemaDefinition: SchemaUnionOutputTypeDef, # (2)
alias: str,
status: DatasetStatusType, # (3)
ResponseMetadata: ResponseMetadataTypeDef, # (4)
ListDatasetsResponseTypeDef#
# ListDatasetsResponseTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import ListDatasetsResponseTypeDef
def get_value() -> ListDatasetsResponseTypeDef:
return {
"datasets": ...,
}
# ListDatasetsResponseTypeDef definition
class ListDatasetsResponseTypeDef(TypedDict):
datasets: List[DatasetTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
nextToken: NotRequired[str],
- See
List[DatasetTypeDef]
- See ResponseMetadataTypeDef
CreateDatasetRequestTypeDef#
# CreateDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import CreateDatasetRequestTypeDef
def get_value() -> CreateDatasetRequestTypeDef:
return {
"datasetTitle": ...,
}
# CreateDatasetRequestTypeDef definition
class CreateDatasetRequestTypeDef(TypedDict):
datasetTitle: str,
kind: DatasetKindType, # (1)
permissionGroupParams: PermissionGroupParamsTypeDef, # (2)
clientToken: NotRequired[str],
datasetDescription: NotRequired[str],
ownerInfo: NotRequired[DatasetOwnerInfoTypeDef], # (3)
alias: NotRequired[str],
schemaDefinition: NotRequired[SchemaUnionUnionTypeDef], # (4)
- See DatasetKindType
- See PermissionGroupParamsTypeDef
- See DatasetOwnerInfoTypeDef
- See SchemaUnionUnionTypeDef
UpdateDatasetRequestTypeDef#
# UpdateDatasetRequestTypeDef TypedDict usage example
from mypy_boto3_finspace_data.type_defs import UpdateDatasetRequestTypeDef
def get_value() -> UpdateDatasetRequestTypeDef:
return {
"datasetId": ...,
}
# UpdateDatasetRequestTypeDef definition
class UpdateDatasetRequestTypeDef(TypedDict):
datasetId: str,
datasetTitle: str,
kind: DatasetKindType, # (1)
clientToken: NotRequired[str],
datasetDescription: NotRequired[str],
alias: NotRequired[str],
schemaDefinition: NotRequired[SchemaUnionUnionTypeDef], # (2)