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