Typed dictionaries
Index > CleanRoomsService > Typed dictionaries
Auto-generated documentation for CleanRoomsService type annotations stubs module mypy-boto3-cleanrooms.
AggregateColumnTypeDef
# AggregateColumnTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import AggregateColumnTypeDef
def get_value() -> AggregateColumnTypeDef:
return {
"columnNames": ...,
"function": ...,
}
# AggregateColumnTypeDef definition
class AggregateColumnTypeDef(TypedDict):
columnNames: Sequence[str],
function: AggregateFunctionNameType, # (1)
AggregationConstraintTypeDef
# AggregationConstraintTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import AggregationConstraintTypeDef
def get_value() -> AggregationConstraintTypeDef:
return {
"columnName": ...,
"minimum": ...,
"type": ...,
}
# AggregationConstraintTypeDef definition
class AggregationConstraintTypeDef(TypedDict):
columnName: str,
minimum: int,
type: AggregationTypeType, # (1)
AnalysisRuleListTypeDef
# AnalysisRuleListTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import AnalysisRuleListTypeDef
def get_value() -> AnalysisRuleListTypeDef:
return {
"joinColumns": ...,
"listColumns": ...,
}
# AnalysisRuleListTypeDef definition
class AnalysisRuleListTypeDef(TypedDict):
joinColumns: Sequence[str],
listColumns: Sequence[str],
BatchGetSchemaErrorTypeDef
# BatchGetSchemaErrorTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import BatchGetSchemaErrorTypeDef
def get_value() -> BatchGetSchemaErrorTypeDef:
return {
"name": ...,
"code": ...,
"message": ...,
}
# BatchGetSchemaErrorTypeDef definition
class BatchGetSchemaErrorTypeDef(TypedDict):
name: str,
code: str,
message: str,
BatchGetSchemaInputRequestTypeDef
# BatchGetSchemaInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import BatchGetSchemaInputRequestTypeDef
def get_value() -> BatchGetSchemaInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
"names": ...,
}
# BatchGetSchemaInputRequestTypeDef definition
class BatchGetSchemaInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
names: Sequence[str],
ResponseMetadataTypeDef
# ResponseMetadataTypeDef usage example
from mypy_boto3_cleanrooms.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,
CollaborationSummaryTypeDef
# CollaborationSummaryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CollaborationSummaryTypeDef
def get_value() -> CollaborationSummaryTypeDef:
return {
"id": ...,
"arn": ...,
"name": ...,
"creatorAccountId": ...,
"creatorDisplayName": ...,
"createTime": ...,
"updateTime": ...,
"memberStatus": ...,
}
# CollaborationSummaryTypeDef definition
class CollaborationSummaryTypeDef(TypedDict):
id: str,
arn: str,
name: str,
creatorAccountId: str,
creatorDisplayName: str,
createTime: datetime,
updateTime: datetime,
memberStatus: MemberStatusType, # (1)
membershipId: NotRequired[str],
membershipArn: NotRequired[str],
- See MemberStatusType
DataEncryptionMetadataTypeDef
# DataEncryptionMetadataTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import DataEncryptionMetadataTypeDef
def get_value() -> DataEncryptionMetadataTypeDef:
return {
"allowCleartext": ...,
"allowDuplicates": ...,
"allowJoinsOnColumnsWithDifferentNames": ...,
"preserveNulls": ...,
}
# DataEncryptionMetadataTypeDef definition
class DataEncryptionMetadataTypeDef(TypedDict):
allowCleartext: bool,
allowDuplicates: bool,
allowJoinsOnColumnsWithDifferentNames: bool,
preserveNulls: bool,
ColumnTypeDef
# ColumnTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ColumnTypeDef
def get_value() -> ColumnTypeDef:
return {
"name": ...,
"type": ...,
}
# ColumnTypeDef definition
class ColumnTypeDef(TypedDict):
name: str,
type: str,
ConfiguredTableAssociationSummaryTypeDef
# ConfiguredTableAssociationSummaryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAssociationSummaryTypeDef
def get_value() -> ConfiguredTableAssociationSummaryTypeDef:
return {
"configuredTableId": ...,
"membershipId": ...,
"membershipArn": ...,
"name": ...,
"createTime": ...,
"updateTime": ...,
"id": ...,
"arn": ...,
}
# ConfiguredTableAssociationSummaryTypeDef definition
class ConfiguredTableAssociationSummaryTypeDef(TypedDict):
configuredTableId: str,
membershipId: str,
membershipArn: str,
name: str,
createTime: datetime,
updateTime: datetime,
id: str,
arn: str,
ConfiguredTableAssociationTypeDef
# ConfiguredTableAssociationTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAssociationTypeDef
def get_value() -> ConfiguredTableAssociationTypeDef:
return {
"arn": ...,
"id": ...,
"configuredTableId": ...,
"configuredTableArn": ...,
"membershipId": ...,
"membershipArn": ...,
"roleArn": ...,
"name": ...,
"createTime": ...,
"updateTime": ...,
}
# ConfiguredTableAssociationTypeDef definition
class ConfiguredTableAssociationTypeDef(TypedDict):
arn: str,
id: str,
configuredTableId: str,
configuredTableArn: str,
membershipId: str,
membershipArn: str,
roleArn: str,
name: str,
createTime: datetime,
updateTime: datetime,
description: NotRequired[str],
ConfiguredTableSummaryTypeDef
# ConfiguredTableSummaryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableSummaryTypeDef
def get_value() -> ConfiguredTableSummaryTypeDef:
return {
"id": ...,
"arn": ...,
"name": ...,
"createTime": ...,
"updateTime": ...,
"analysisRuleTypes": ...,
"analysisMethod": ...,
}
# ConfiguredTableSummaryTypeDef definition
class ConfiguredTableSummaryTypeDef(TypedDict):
id: str,
arn: str,
name: str,
createTime: datetime,
updateTime: datetime,
analysisRuleTypes: List[ConfiguredTableAnalysisRuleTypeType], # (1)
analysisMethod: AnalysisMethodType, # (2)
MemberSpecificationTypeDef
# MemberSpecificationTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import MemberSpecificationTypeDef
def get_value() -> MemberSpecificationTypeDef:
return {
"accountId": ...,
"memberAbilities": ...,
"displayName": ...,
}
# MemberSpecificationTypeDef definition
class MemberSpecificationTypeDef(TypedDict):
accountId: str,
memberAbilities: Sequence[MemberAbilityType], # (1)
displayName: str,
CreateConfiguredTableAssociationInputRequestTypeDef
# CreateConfiguredTableAssociationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAssociationInputRequestTypeDef
def get_value() -> CreateConfiguredTableAssociationInputRequestTypeDef:
return {
"name": ...,
"membershipIdentifier": ...,
"configuredTableIdentifier": ...,
"roleArn": ...,
}
# CreateConfiguredTableAssociationInputRequestTypeDef definition
class CreateConfiguredTableAssociationInputRequestTypeDef(TypedDict):
name: str,
membershipIdentifier: str,
configuredTableIdentifier: str,
roleArn: str,
description: NotRequired[str],
CreateMembershipInputRequestTypeDef
# CreateMembershipInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateMembershipInputRequestTypeDef
def get_value() -> CreateMembershipInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
"queryLogStatus": ...,
}
# CreateMembershipInputRequestTypeDef definition
class CreateMembershipInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
queryLogStatus: MembershipQueryLogStatusType, # (1)
MembershipTypeDef
# MembershipTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import MembershipTypeDef
def get_value() -> MembershipTypeDef:
return {
"id": ...,
"arn": ...,
"collaborationArn": ...,
"collaborationId": ...,
"collaborationCreatorAccountId": ...,
"collaborationCreatorDisplayName": ...,
"collaborationName": ...,
"createTime": ...,
"updateTime": ...,
"status": ...,
"memberAbilities": ...,
"queryLogStatus": ...,
}
# MembershipTypeDef definition
class MembershipTypeDef(TypedDict):
id: str,
arn: str,
collaborationArn: str,
collaborationId: str,
collaborationCreatorAccountId: str,
collaborationCreatorDisplayName: str,
collaborationName: str,
createTime: datetime,
updateTime: datetime,
status: MembershipStatusType, # (1)
memberAbilities: List[MemberAbilityType], # (2)
queryLogStatus: MembershipQueryLogStatusType, # (3)
DeleteCollaborationInputRequestTypeDef
# DeleteCollaborationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import DeleteCollaborationInputRequestTypeDef
def get_value() -> DeleteCollaborationInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
}
# DeleteCollaborationInputRequestTypeDef definition
class DeleteCollaborationInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
DeleteConfiguredTableAnalysisRuleInputRequestTypeDef
# DeleteConfiguredTableAnalysisRuleInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import DeleteConfiguredTableAnalysisRuleInputRequestTypeDef
def get_value() -> DeleteConfiguredTableAnalysisRuleInputRequestTypeDef:
return {
"configuredTableIdentifier": ...,
"analysisRuleType": ...,
}
# DeleteConfiguredTableAnalysisRuleInputRequestTypeDef definition
class DeleteConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
DeleteConfiguredTableAssociationInputRequestTypeDef
# DeleteConfiguredTableAssociationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import DeleteConfiguredTableAssociationInputRequestTypeDef
def get_value() -> DeleteConfiguredTableAssociationInputRequestTypeDef:
return {
"configuredTableAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
# DeleteConfiguredTableAssociationInputRequestTypeDef definition
class DeleteConfiguredTableAssociationInputRequestTypeDef(TypedDict):
configuredTableAssociationIdentifier: str,
membershipIdentifier: str,
DeleteConfiguredTableInputRequestTypeDef
# DeleteConfiguredTableInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import DeleteConfiguredTableInputRequestTypeDef
def get_value() -> DeleteConfiguredTableInputRequestTypeDef:
return {
"configuredTableIdentifier": ...,
}
# DeleteConfiguredTableInputRequestTypeDef definition
class DeleteConfiguredTableInputRequestTypeDef(TypedDict):
configuredTableIdentifier: str,
DeleteMemberInputRequestTypeDef
# DeleteMemberInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import DeleteMemberInputRequestTypeDef
def get_value() -> DeleteMemberInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
"accountId": ...,
}
# DeleteMemberInputRequestTypeDef definition
class DeleteMemberInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
accountId: str,
DeleteMembershipInputRequestTypeDef
# DeleteMembershipInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import DeleteMembershipInputRequestTypeDef
def get_value() -> DeleteMembershipInputRequestTypeDef:
return {
"membershipIdentifier": ...,
}
# DeleteMembershipInputRequestTypeDef definition
class DeleteMembershipInputRequestTypeDef(TypedDict):
membershipIdentifier: str,
GetCollaborationInputRequestTypeDef
# GetCollaborationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetCollaborationInputRequestTypeDef
def get_value() -> GetCollaborationInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
}
# GetCollaborationInputRequestTypeDef definition
class GetCollaborationInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
GetConfiguredTableAnalysisRuleInputRequestTypeDef
# GetConfiguredTableAnalysisRuleInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAnalysisRuleInputRequestTypeDef
def get_value() -> GetConfiguredTableAnalysisRuleInputRequestTypeDef:
return {
"configuredTableIdentifier": ...,
"analysisRuleType": ...,
}
# GetConfiguredTableAnalysisRuleInputRequestTypeDef definition
class GetConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
GetConfiguredTableAssociationInputRequestTypeDef
# GetConfiguredTableAssociationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAssociationInputRequestTypeDef
def get_value() -> GetConfiguredTableAssociationInputRequestTypeDef:
return {
"configuredTableAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
# GetConfiguredTableAssociationInputRequestTypeDef definition
class GetConfiguredTableAssociationInputRequestTypeDef(TypedDict):
configuredTableAssociationIdentifier: str,
membershipIdentifier: str,
GetConfiguredTableInputRequestTypeDef
# GetConfiguredTableInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableInputRequestTypeDef
def get_value() -> GetConfiguredTableInputRequestTypeDef:
return {
"configuredTableIdentifier": ...,
}
# GetConfiguredTableInputRequestTypeDef definition
class GetConfiguredTableInputRequestTypeDef(TypedDict):
configuredTableIdentifier: str,
GetMembershipInputRequestTypeDef
# GetMembershipInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetMembershipInputRequestTypeDef
def get_value() -> GetMembershipInputRequestTypeDef:
return {
"membershipIdentifier": ...,
}
# GetMembershipInputRequestTypeDef definition
class GetMembershipInputRequestTypeDef(TypedDict):
membershipIdentifier: str,
GetProtectedQueryInputRequestTypeDef
# GetProtectedQueryInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetProtectedQueryInputRequestTypeDef
def get_value() -> GetProtectedQueryInputRequestTypeDef:
return {
"membershipIdentifier": ...,
"protectedQueryIdentifier": ...,
}
# GetProtectedQueryInputRequestTypeDef definition
class GetProtectedQueryInputRequestTypeDef(TypedDict):
membershipIdentifier: str,
protectedQueryIdentifier: str,
GetSchemaAnalysisRuleInputRequestTypeDef
# GetSchemaAnalysisRuleInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetSchemaAnalysisRuleInputRequestTypeDef
def get_value() -> GetSchemaAnalysisRuleInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
"name": ...,
"type": ...,
}
# GetSchemaAnalysisRuleInputRequestTypeDef definition
class GetSchemaAnalysisRuleInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
name: str,
type: AnalysisRuleTypeType, # (1)
GetSchemaInputRequestTypeDef
# GetSchemaInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetSchemaInputRequestTypeDef
def get_value() -> GetSchemaInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
"name": ...,
}
# GetSchemaInputRequestTypeDef definition
class GetSchemaInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
name: str,
GlueTableReferenceTypeDef
# GlueTableReferenceTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GlueTableReferenceTypeDef
def get_value() -> GlueTableReferenceTypeDef:
return {
"tableName": ...,
"databaseName": ...,
}
# GlueTableReferenceTypeDef definition
class GlueTableReferenceTypeDef(TypedDict):
tableName: str,
databaseName: str,
PaginatorConfigTypeDef
# PaginatorConfigTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
# PaginatorConfigTypeDef definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListCollaborationsInputRequestTypeDef
# ListCollaborationsInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListCollaborationsInputRequestTypeDef
def get_value() -> ListCollaborationsInputRequestTypeDef:
return {
"nextToken": ...,
}
# ListCollaborationsInputRequestTypeDef definition
class ListCollaborationsInputRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
memberStatus: NotRequired[FilterableMemberStatusType], # (1)
ListConfiguredTableAssociationsInputRequestTypeDef
# ListConfiguredTableAssociationsInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTableAssociationsInputRequestTypeDef
def get_value() -> ListConfiguredTableAssociationsInputRequestTypeDef:
return {
"membershipIdentifier": ...,
}
# ListConfiguredTableAssociationsInputRequestTypeDef definition
class ListConfiguredTableAssociationsInputRequestTypeDef(TypedDict):
membershipIdentifier: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListConfiguredTablesInputRequestTypeDef
# ListConfiguredTablesInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTablesInputRequestTypeDef
def get_value() -> ListConfiguredTablesInputRequestTypeDef:
return {
"nextToken": ...,
}
# ListConfiguredTablesInputRequestTypeDef definition
class ListConfiguredTablesInputRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListMembersInputRequestTypeDef
# ListMembersInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListMembersInputRequestTypeDef
def get_value() -> ListMembersInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
}
# ListMembersInputRequestTypeDef definition
class ListMembersInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
nextToken: NotRequired[str],
maxResults: NotRequired[int],
MemberSummaryTypeDef
# MemberSummaryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import MemberSummaryTypeDef
def get_value() -> MemberSummaryTypeDef:
return {
"accountId": ...,
"status": ...,
"displayName": ...,
"abilities": ...,
"createTime": ...,
"updateTime": ...,
}
# MemberSummaryTypeDef definition
class MemberSummaryTypeDef(TypedDict):
accountId: str,
status: MemberStatusType, # (1)
displayName: str,
abilities: List[MemberAbilityType], # (2)
createTime: datetime,
updateTime: datetime,
membershipId: NotRequired[str],
membershipArn: NotRequired[str],
- See MemberStatusType
- See MemberAbilityType
ListMembershipsInputRequestTypeDef
# ListMembershipsInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListMembershipsInputRequestTypeDef
def get_value() -> ListMembershipsInputRequestTypeDef:
return {
"nextToken": ...,
}
# ListMembershipsInputRequestTypeDef definition
class ListMembershipsInputRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
status: NotRequired[MembershipStatusType], # (1)
MembershipSummaryTypeDef
# MembershipSummaryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import MembershipSummaryTypeDef
def get_value() -> MembershipSummaryTypeDef:
return {
"id": ...,
"arn": ...,
"collaborationArn": ...,
"collaborationId": ...,
"collaborationCreatorAccountId": ...,
"collaborationCreatorDisplayName": ...,
"collaborationName": ...,
"createTime": ...,
"updateTime": ...,
"status": ...,
"memberAbilities": ...,
}
# MembershipSummaryTypeDef definition
class MembershipSummaryTypeDef(TypedDict):
id: str,
arn: str,
collaborationArn: str,
collaborationId: str,
collaborationCreatorAccountId: str,
collaborationCreatorDisplayName: str,
collaborationName: str,
createTime: datetime,
updateTime: datetime,
status: MembershipStatusType, # (1)
memberAbilities: List[MemberAbilityType], # (2)
ListProtectedQueriesInputRequestTypeDef
# ListProtectedQueriesInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListProtectedQueriesInputRequestTypeDef
def get_value() -> ListProtectedQueriesInputRequestTypeDef:
return {
"membershipIdentifier": ...,
}
# ListProtectedQueriesInputRequestTypeDef definition
class ListProtectedQueriesInputRequestTypeDef(TypedDict):
membershipIdentifier: str,
status: NotRequired[ProtectedQueryStatusType], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ProtectedQuerySummaryTypeDef
# ProtectedQuerySummaryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQuerySummaryTypeDef
def get_value() -> ProtectedQuerySummaryTypeDef:
return {
"id": ...,
"membershipId": ...,
"membershipArn": ...,
"createTime": ...,
"status": ...,
}
# ProtectedQuerySummaryTypeDef definition
class ProtectedQuerySummaryTypeDef(TypedDict):
id: str,
membershipId: str,
membershipArn: str,
createTime: datetime,
status: ProtectedQueryStatusType, # (1)
ListSchemasInputRequestTypeDef
# ListSchemasInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListSchemasInputRequestTypeDef
def get_value() -> ListSchemasInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
}
# ListSchemasInputRequestTypeDef definition
class ListSchemasInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
schemaType: NotRequired[SchemaTypeType], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
- See SchemaTypeType
SchemaSummaryTypeDef
# SchemaSummaryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import SchemaSummaryTypeDef
def get_value() -> SchemaSummaryTypeDef:
return {
"name": ...,
"type": ...,
"creatorAccountId": ...,
"createTime": ...,
"updateTime": ...,
"collaborationId": ...,
"collaborationArn": ...,
"analysisRuleTypes": ...,
}
# SchemaSummaryTypeDef definition
class SchemaSummaryTypeDef(TypedDict):
name: str,
type: SchemaTypeType, # (1)
creatorAccountId: str,
createTime: datetime,
updateTime: datetime,
collaborationId: str,
collaborationArn: str,
analysisRuleTypes: List[AnalysisRuleTypeType], # (2)
analysisMethod: NotRequired[AnalysisMethodType], # (3)
- See SchemaTypeType
- See AnalysisRuleTypeType
- See AnalysisMethodType
ProtectedQueryErrorTypeDef
# ProtectedQueryErrorTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryErrorTypeDef
def get_value() -> ProtectedQueryErrorTypeDef:
return {
"message": ...,
"code": ...,
}
# ProtectedQueryErrorTypeDef definition
class ProtectedQueryErrorTypeDef(TypedDict):
message: str,
code: str,
ProtectedQueryS3OutputConfigurationTypeDef
# ProtectedQueryS3OutputConfigurationTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryS3OutputConfigurationTypeDef
def get_value() -> ProtectedQueryS3OutputConfigurationTypeDef:
return {
"resultFormat": ...,
"bucket": ...,
}
# ProtectedQueryS3OutputConfigurationTypeDef definition
class ProtectedQueryS3OutputConfigurationTypeDef(TypedDict):
resultFormat: ResultFormatType, # (1)
bucket: str,
keyPrefix: NotRequired[str],
- See ResultFormatType
ProtectedQueryS3OutputTypeDef
# ProtectedQueryS3OutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryS3OutputTypeDef
def get_value() -> ProtectedQueryS3OutputTypeDef:
return {
"location": ...,
}
# ProtectedQueryS3OutputTypeDef definition
class ProtectedQueryS3OutputTypeDef(TypedDict):
location: str,
ProtectedQuerySQLParametersTypeDef
# ProtectedQuerySQLParametersTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQuerySQLParametersTypeDef
def get_value() -> ProtectedQuerySQLParametersTypeDef:
return {
"queryString": ...,
}
# ProtectedQuerySQLParametersTypeDef definition
class ProtectedQuerySQLParametersTypeDef(TypedDict):
queryString: str,
ProtectedQueryStatisticsTypeDef
# ProtectedQueryStatisticsTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryStatisticsTypeDef
def get_value() -> ProtectedQueryStatisticsTypeDef:
return {
"totalDurationInMillis": ...,
}
# ProtectedQueryStatisticsTypeDef definition
class ProtectedQueryStatisticsTypeDef(TypedDict):
totalDurationInMillis: NotRequired[int],
UpdateCollaborationInputRequestTypeDef
# UpdateCollaborationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateCollaborationInputRequestTypeDef
def get_value() -> UpdateCollaborationInputRequestTypeDef:
return {
"collaborationIdentifier": ...,
}
# UpdateCollaborationInputRequestTypeDef definition
class UpdateCollaborationInputRequestTypeDef(TypedDict):
collaborationIdentifier: str,
name: NotRequired[str],
description: NotRequired[str],
UpdateConfiguredTableAssociationInputRequestTypeDef
# UpdateConfiguredTableAssociationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAssociationInputRequestTypeDef
def get_value() -> UpdateConfiguredTableAssociationInputRequestTypeDef:
return {
"configuredTableAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
# UpdateConfiguredTableAssociationInputRequestTypeDef definition
class UpdateConfiguredTableAssociationInputRequestTypeDef(TypedDict):
configuredTableAssociationIdentifier: str,
membershipIdentifier: str,
description: NotRequired[str],
roleArn: NotRequired[str],
UpdateConfiguredTableInputRequestTypeDef
# UpdateConfiguredTableInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableInputRequestTypeDef
def get_value() -> UpdateConfiguredTableInputRequestTypeDef:
return {
"configuredTableIdentifier": ...,
}
# UpdateConfiguredTableInputRequestTypeDef definition
class UpdateConfiguredTableInputRequestTypeDef(TypedDict):
configuredTableIdentifier: str,
name: NotRequired[str],
description: NotRequired[str],
UpdateMembershipInputRequestTypeDef
# UpdateMembershipInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateMembershipInputRequestTypeDef
def get_value() -> UpdateMembershipInputRequestTypeDef:
return {
"membershipIdentifier": ...,
}
# UpdateMembershipInputRequestTypeDef definition
class UpdateMembershipInputRequestTypeDef(TypedDict):
membershipIdentifier: str,
queryLogStatus: NotRequired[MembershipQueryLogStatusType], # (1)
UpdateProtectedQueryInputRequestTypeDef
# UpdateProtectedQueryInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateProtectedQueryInputRequestTypeDef
def get_value() -> UpdateProtectedQueryInputRequestTypeDef:
return {
"membershipIdentifier": ...,
"protectedQueryIdentifier": ...,
"targetStatus": ...,
}
# UpdateProtectedQueryInputRequestTypeDef definition
class UpdateProtectedQueryInputRequestTypeDef(TypedDict):
membershipIdentifier: str,
protectedQueryIdentifier: str,
targetStatus: TargetProtectedQueryStatusType, # (1)
AnalysisRuleAggregationTypeDef
# AnalysisRuleAggregationTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import AnalysisRuleAggregationTypeDef
def get_value() -> AnalysisRuleAggregationTypeDef:
return {
"aggregateColumns": ...,
"joinColumns": ...,
"dimensionColumns": ...,
"scalarFunctions": ...,
"outputConstraints": ...,
}
# AnalysisRuleAggregationTypeDef definition
class AnalysisRuleAggregationTypeDef(TypedDict):
aggregateColumns: Sequence[AggregateColumnTypeDef], # (1)
joinColumns: Sequence[str],
dimensionColumns: Sequence[str],
scalarFunctions: Sequence[ScalarFunctionsType], # (3)
outputConstraints: Sequence[AggregationConstraintTypeDef], # (4)
joinRequired: NotRequired[JoinRequiredOptionType], # (2)
- See AggregateColumnTypeDef
- See JoinRequiredOptionType
- See ScalarFunctionsType
- See AggregationConstraintTypeDef
ListCollaborationsOutputTypeDef
# ListCollaborationsOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListCollaborationsOutputTypeDef
def get_value() -> ListCollaborationsOutputTypeDef:
return {
"nextToken": ...,
"collaborationList": ...,
"ResponseMetadata": ...,
}
# ListCollaborationsOutputTypeDef definition
class ListCollaborationsOutputTypeDef(TypedDict):
nextToken: str,
collaborationList: List[CollaborationSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CollaborationTypeDef
# CollaborationTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CollaborationTypeDef
def get_value() -> CollaborationTypeDef:
return {
"id": ...,
"arn": ...,
"name": ...,
"creatorAccountId": ...,
"creatorDisplayName": ...,
"createTime": ...,
"updateTime": ...,
"memberStatus": ...,
"queryLogStatus": ...,
}
# CollaborationTypeDef definition
class CollaborationTypeDef(TypedDict):
id: str,
arn: str,
name: str,
creatorAccountId: str,
creatorDisplayName: str,
createTime: datetime,
updateTime: datetime,
memberStatus: MemberStatusType, # (1)
queryLogStatus: CollaborationQueryLogStatusType, # (3)
description: NotRequired[str],
membershipId: NotRequired[str],
membershipArn: NotRequired[str],
dataEncryptionMetadata: NotRequired[DataEncryptionMetadataTypeDef], # (2)
SchemaTypeDef
# SchemaTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import SchemaTypeDef
def get_value() -> SchemaTypeDef:
return {
"columns": ...,
"partitionKeys": ...,
"analysisRuleTypes": ...,
"creatorAccountId": ...,
"name": ...,
"collaborationId": ...,
"collaborationArn": ...,
"description": ...,
"createTime": ...,
"updateTime": ...,
"type": ...,
}
# SchemaTypeDef definition
class SchemaTypeDef(TypedDict):
columns: List[ColumnTypeDef], # (1)
partitionKeys: List[ColumnTypeDef], # (1)
analysisRuleTypes: List[AnalysisRuleTypeType], # (3)
creatorAccountId: str,
name: str,
collaborationId: str,
collaborationArn: str,
description: str,
createTime: datetime,
updateTime: datetime,
type: SchemaTypeType, # (5)
analysisMethod: NotRequired[AnalysisMethodType], # (4)
- See ColumnTypeDef
- See ColumnTypeDef
- See AnalysisRuleTypeType
- See AnalysisMethodType
- See SchemaTypeType
ListConfiguredTableAssociationsOutputTypeDef
# ListConfiguredTableAssociationsOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTableAssociationsOutputTypeDef
def get_value() -> ListConfiguredTableAssociationsOutputTypeDef:
return {
"configuredTableAssociationSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListConfiguredTableAssociationsOutputTypeDef definition
class ListConfiguredTableAssociationsOutputTypeDef(TypedDict):
configuredTableAssociationSummaries: List[ConfiguredTableAssociationSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateConfiguredTableAssociationOutputTypeDef
# CreateConfiguredTableAssociationOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAssociationOutputTypeDef
def get_value() -> CreateConfiguredTableAssociationOutputTypeDef:
return {
"configuredTableAssociation": ...,
"ResponseMetadata": ...,
}
# CreateConfiguredTableAssociationOutputTypeDef definition
class CreateConfiguredTableAssociationOutputTypeDef(TypedDict):
configuredTableAssociation: ConfiguredTableAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetConfiguredTableAssociationOutputTypeDef
# GetConfiguredTableAssociationOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAssociationOutputTypeDef
def get_value() -> GetConfiguredTableAssociationOutputTypeDef:
return {
"configuredTableAssociation": ...,
"ResponseMetadata": ...,
}
# GetConfiguredTableAssociationOutputTypeDef definition
class GetConfiguredTableAssociationOutputTypeDef(TypedDict):
configuredTableAssociation: ConfiguredTableAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateConfiguredTableAssociationOutputTypeDef
# UpdateConfiguredTableAssociationOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAssociationOutputTypeDef
def get_value() -> UpdateConfiguredTableAssociationOutputTypeDef:
return {
"configuredTableAssociation": ...,
"ResponseMetadata": ...,
}
# UpdateConfiguredTableAssociationOutputTypeDef definition
class UpdateConfiguredTableAssociationOutputTypeDef(TypedDict):
configuredTableAssociation: ConfiguredTableAssociationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListConfiguredTablesOutputTypeDef
# ListConfiguredTablesOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTablesOutputTypeDef
def get_value() -> ListConfiguredTablesOutputTypeDef:
return {
"configuredTableSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListConfiguredTablesOutputTypeDef definition
class ListConfiguredTablesOutputTypeDef(TypedDict):
configuredTableSummaries: List[ConfiguredTableSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateCollaborationInputRequestTypeDef
# CreateCollaborationInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateCollaborationInputRequestTypeDef
def get_value() -> CreateCollaborationInputRequestTypeDef:
return {
"members": ...,
"name": ...,
"description": ...,
"creatorMemberAbilities": ...,
"creatorDisplayName": ...,
"queryLogStatus": ...,
}
# CreateCollaborationInputRequestTypeDef definition
class CreateCollaborationInputRequestTypeDef(TypedDict):
members: Sequence[MemberSpecificationTypeDef], # (1)
name: str,
description: str,
creatorMemberAbilities: Sequence[MemberAbilityType], # (2)
creatorDisplayName: str,
queryLogStatus: CollaborationQueryLogStatusType, # (3)
dataEncryptionMetadata: NotRequired[DataEncryptionMetadataTypeDef], # (4)
- See MemberSpecificationTypeDef
- See MemberAbilityType
- See CollaborationQueryLogStatusType
- See DataEncryptionMetadataTypeDef
CreateMembershipOutputTypeDef
# CreateMembershipOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateMembershipOutputTypeDef
def get_value() -> CreateMembershipOutputTypeDef:
return {
"membership": ...,
"ResponseMetadata": ...,
}
# CreateMembershipOutputTypeDef definition
class CreateMembershipOutputTypeDef(TypedDict):
membership: MembershipTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetMembershipOutputTypeDef
# GetMembershipOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetMembershipOutputTypeDef
def get_value() -> GetMembershipOutputTypeDef:
return {
"membership": ...,
"ResponseMetadata": ...,
}
# GetMembershipOutputTypeDef definition
class GetMembershipOutputTypeDef(TypedDict):
membership: MembershipTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateMembershipOutputTypeDef
# UpdateMembershipOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateMembershipOutputTypeDef
def get_value() -> UpdateMembershipOutputTypeDef:
return {
"membership": ...,
"ResponseMetadata": ...,
}
# UpdateMembershipOutputTypeDef definition
class UpdateMembershipOutputTypeDef(TypedDict):
membership: MembershipTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
TableReferenceTypeDef
# TableReferenceTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import TableReferenceTypeDef
def get_value() -> TableReferenceTypeDef:
return {
"glue": ...,
}
# TableReferenceTypeDef definition
class TableReferenceTypeDef(TypedDict):
glue: NotRequired[GlueTableReferenceTypeDef], # (1)
ListCollaborationsInputListCollaborationsPaginateTypeDef
# ListCollaborationsInputListCollaborationsPaginateTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListCollaborationsInputListCollaborationsPaginateTypeDef
def get_value() -> ListCollaborationsInputListCollaborationsPaginateTypeDef:
return {
"memberStatus": ...,
}
# ListCollaborationsInputListCollaborationsPaginateTypeDef definition
class ListCollaborationsInputListCollaborationsPaginateTypeDef(TypedDict):
memberStatus: NotRequired[FilterableMemberStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef
# ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef
def get_value() -> ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef:
return {
"membershipIdentifier": ...,
}
# ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef definition
class ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef(TypedDict):
membershipIdentifier: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef
# ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef
def get_value() -> ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef:
return {
"PaginationConfig": ...,
}
# ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef definition
class ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef(TypedDict):
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListMembersInputListMembersPaginateTypeDef
# ListMembersInputListMembersPaginateTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListMembersInputListMembersPaginateTypeDef
def get_value() -> ListMembersInputListMembersPaginateTypeDef:
return {
"collaborationIdentifier": ...,
}
# ListMembersInputListMembersPaginateTypeDef definition
class ListMembersInputListMembersPaginateTypeDef(TypedDict):
collaborationIdentifier: str,
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (1)
ListMembershipsInputListMembershipsPaginateTypeDef
# ListMembershipsInputListMembershipsPaginateTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListMembershipsInputListMembershipsPaginateTypeDef
def get_value() -> ListMembershipsInputListMembershipsPaginateTypeDef:
return {
"status": ...,
}
# ListMembershipsInputListMembershipsPaginateTypeDef definition
class ListMembershipsInputListMembershipsPaginateTypeDef(TypedDict):
status: NotRequired[MembershipStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef
# ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef
def get_value() -> ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef:
return {
"membershipIdentifier": ...,
}
# ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef definition
class ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef(TypedDict):
membershipIdentifier: str,
status: NotRequired[ProtectedQueryStatusType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
ListSchemasInputListSchemasPaginateTypeDef
# ListSchemasInputListSchemasPaginateTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListSchemasInputListSchemasPaginateTypeDef
def get_value() -> ListSchemasInputListSchemasPaginateTypeDef:
return {
"collaborationIdentifier": ...,
}
# ListSchemasInputListSchemasPaginateTypeDef definition
class ListSchemasInputListSchemasPaginateTypeDef(TypedDict):
collaborationIdentifier: str,
schemaType: NotRequired[SchemaTypeType], # (1)
PaginationConfig: NotRequired[PaginatorConfigTypeDef], # (2)
- See SchemaTypeType
- See PaginatorConfigTypeDef
ListMembersOutputTypeDef
# ListMembersOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListMembersOutputTypeDef
def get_value() -> ListMembersOutputTypeDef:
return {
"nextToken": ...,
"memberSummaries": ...,
"ResponseMetadata": ...,
}
# ListMembersOutputTypeDef definition
class ListMembersOutputTypeDef(TypedDict):
nextToken: str,
memberSummaries: List[MemberSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListMembershipsOutputTypeDef
# ListMembershipsOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListMembershipsOutputTypeDef
def get_value() -> ListMembershipsOutputTypeDef:
return {
"nextToken": ...,
"membershipSummaries": ...,
"ResponseMetadata": ...,
}
# ListMembershipsOutputTypeDef definition
class ListMembershipsOutputTypeDef(TypedDict):
nextToken: str,
membershipSummaries: List[MembershipSummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListProtectedQueriesOutputTypeDef
# ListProtectedQueriesOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListProtectedQueriesOutputTypeDef
def get_value() -> ListProtectedQueriesOutputTypeDef:
return {
"nextToken": ...,
"protectedQueries": ...,
"ResponseMetadata": ...,
}
# ListProtectedQueriesOutputTypeDef definition
class ListProtectedQueriesOutputTypeDef(TypedDict):
nextToken: str,
protectedQueries: List[ProtectedQuerySummaryTypeDef], # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ListSchemasOutputTypeDef
# ListSchemasOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ListSchemasOutputTypeDef
def get_value() -> ListSchemasOutputTypeDef:
return {
"schemaSummaries": ...,
"nextToken": ...,
"ResponseMetadata": ...,
}
# ListSchemasOutputTypeDef definition
class ListSchemasOutputTypeDef(TypedDict):
schemaSummaries: List[SchemaSummaryTypeDef], # (1)
nextToken: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
ProtectedQueryOutputConfigurationTypeDef
# ProtectedQueryOutputConfigurationTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryOutputConfigurationTypeDef
def get_value() -> ProtectedQueryOutputConfigurationTypeDef:
return {
"s3": ...,
}
# ProtectedQueryOutputConfigurationTypeDef definition
class ProtectedQueryOutputConfigurationTypeDef(TypedDict):
s3: NotRequired[ProtectedQueryS3OutputConfigurationTypeDef], # (1)
ProtectedQueryOutputTypeDef
# ProtectedQueryOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryOutputTypeDef
def get_value() -> ProtectedQueryOutputTypeDef:
return {
"s3": ...,
}
# ProtectedQueryOutputTypeDef definition
class ProtectedQueryOutputTypeDef(TypedDict):
s3: NotRequired[ProtectedQueryS3OutputTypeDef], # (1)
AnalysisRulePolicyV1TypeDef
# AnalysisRulePolicyV1TypeDef usage example
from mypy_boto3_cleanrooms.type_defs import AnalysisRulePolicyV1TypeDef
def get_value() -> AnalysisRulePolicyV1TypeDef:
return {
"list": ...,
}
# AnalysisRulePolicyV1TypeDef definition
class AnalysisRulePolicyV1TypeDef(TypedDict):
list: NotRequired[AnalysisRuleListTypeDef], # (1)
aggregation: NotRequired[AnalysisRuleAggregationTypeDef], # (2)
ConfiguredTableAnalysisRulePolicyV1TypeDef
# ConfiguredTableAnalysisRulePolicyV1TypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAnalysisRulePolicyV1TypeDef
def get_value() -> ConfiguredTableAnalysisRulePolicyV1TypeDef:
return {
"list": ...,
}
# ConfiguredTableAnalysisRulePolicyV1TypeDef definition
class ConfiguredTableAnalysisRulePolicyV1TypeDef(TypedDict):
list: NotRequired[AnalysisRuleListTypeDef], # (1)
aggregation: NotRequired[AnalysisRuleAggregationTypeDef], # (2)
CreateCollaborationOutputTypeDef
# CreateCollaborationOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateCollaborationOutputTypeDef
def get_value() -> CreateCollaborationOutputTypeDef:
return {
"collaboration": ...,
"ResponseMetadata": ...,
}
# CreateCollaborationOutputTypeDef definition
class CreateCollaborationOutputTypeDef(TypedDict):
collaboration: CollaborationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetCollaborationOutputTypeDef
# GetCollaborationOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetCollaborationOutputTypeDef
def get_value() -> GetCollaborationOutputTypeDef:
return {
"collaboration": ...,
"ResponseMetadata": ...,
}
# GetCollaborationOutputTypeDef definition
class GetCollaborationOutputTypeDef(TypedDict):
collaboration: CollaborationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateCollaborationOutputTypeDef
# UpdateCollaborationOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateCollaborationOutputTypeDef
def get_value() -> UpdateCollaborationOutputTypeDef:
return {
"collaboration": ...,
"ResponseMetadata": ...,
}
# UpdateCollaborationOutputTypeDef definition
class UpdateCollaborationOutputTypeDef(TypedDict):
collaboration: CollaborationTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
BatchGetSchemaOutputTypeDef
# BatchGetSchemaOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import BatchGetSchemaOutputTypeDef
def get_value() -> BatchGetSchemaOutputTypeDef:
return {
"schemas": ...,
"errors": ...,
"ResponseMetadata": ...,
}
# BatchGetSchemaOutputTypeDef definition
class BatchGetSchemaOutputTypeDef(TypedDict):
schemas: List[SchemaTypeDef], # (1)
errors: List[BatchGetSchemaErrorTypeDef], # (2)
ResponseMetadata: ResponseMetadataTypeDef, # (3)
GetSchemaOutputTypeDef
# GetSchemaOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetSchemaOutputTypeDef
def get_value() -> GetSchemaOutputTypeDef:
return {
"schema": ...,
"ResponseMetadata": ...,
}
# GetSchemaOutputTypeDef definition
class GetSchemaOutputTypeDef(TypedDict):
schema: SchemaTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See SchemaTypeDef
- See ResponseMetadataTypeDef
ConfiguredTableTypeDef
# ConfiguredTableTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableTypeDef
def get_value() -> ConfiguredTableTypeDef:
return {
"id": ...,
"arn": ...,
"name": ...,
"tableReference": ...,
"createTime": ...,
"updateTime": ...,
"analysisRuleTypes": ...,
"analysisMethod": ...,
"allowedColumns": ...,
}
# ConfiguredTableTypeDef definition
class ConfiguredTableTypeDef(TypedDict):
id: str,
arn: str,
name: str,
tableReference: TableReferenceTypeDef, # (1)
createTime: datetime,
updateTime: datetime,
analysisRuleTypes: List[ConfiguredTableAnalysisRuleTypeType], # (2)
analysisMethod: AnalysisMethodType, # (3)
allowedColumns: List[str],
description: NotRequired[str],
CreateConfiguredTableInputRequestTypeDef
# CreateConfiguredTableInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableInputRequestTypeDef
def get_value() -> CreateConfiguredTableInputRequestTypeDef:
return {
"name": ...,
"tableReference": ...,
"allowedColumns": ...,
"analysisMethod": ...,
}
# CreateConfiguredTableInputRequestTypeDef definition
class CreateConfiguredTableInputRequestTypeDef(TypedDict):
name: str,
tableReference: TableReferenceTypeDef, # (1)
allowedColumns: Sequence[str],
analysisMethod: AnalysisMethodType, # (2)
description: NotRequired[str],
ProtectedQueryResultConfigurationTypeDef
# ProtectedQueryResultConfigurationTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryResultConfigurationTypeDef
def get_value() -> ProtectedQueryResultConfigurationTypeDef:
return {
"outputConfiguration": ...,
}
# ProtectedQueryResultConfigurationTypeDef definition
class ProtectedQueryResultConfigurationTypeDef(TypedDict):
outputConfiguration: ProtectedQueryOutputConfigurationTypeDef, # (1)
ProtectedQueryResultTypeDef
# ProtectedQueryResultTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryResultTypeDef
def get_value() -> ProtectedQueryResultTypeDef:
return {
"output": ...,
}
# ProtectedQueryResultTypeDef definition
class ProtectedQueryResultTypeDef(TypedDict):
output: ProtectedQueryOutputTypeDef, # (1)
AnalysisRulePolicyTypeDef
# AnalysisRulePolicyTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import AnalysisRulePolicyTypeDef
def get_value() -> AnalysisRulePolicyTypeDef:
return {
"v1": ...,
}
# AnalysisRulePolicyTypeDef definition
class AnalysisRulePolicyTypeDef(TypedDict):
v1: NotRequired[AnalysisRulePolicyV1TypeDef], # (1)
ConfiguredTableAnalysisRulePolicyTypeDef
# ConfiguredTableAnalysisRulePolicyTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAnalysisRulePolicyTypeDef
def get_value() -> ConfiguredTableAnalysisRulePolicyTypeDef:
return {
"v1": ...,
}
# ConfiguredTableAnalysisRulePolicyTypeDef definition
class ConfiguredTableAnalysisRulePolicyTypeDef(TypedDict):
v1: NotRequired[ConfiguredTableAnalysisRulePolicyV1TypeDef], # (1)
CreateConfiguredTableOutputTypeDef
# CreateConfiguredTableOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableOutputTypeDef
def get_value() -> CreateConfiguredTableOutputTypeDef:
return {
"configuredTable": ...,
"ResponseMetadata": ...,
}
# CreateConfiguredTableOutputTypeDef definition
class CreateConfiguredTableOutputTypeDef(TypedDict):
configuredTable: ConfiguredTableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetConfiguredTableOutputTypeDef
# GetConfiguredTableOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableOutputTypeDef
def get_value() -> GetConfiguredTableOutputTypeDef:
return {
"configuredTable": ...,
"ResponseMetadata": ...,
}
# GetConfiguredTableOutputTypeDef definition
class GetConfiguredTableOutputTypeDef(TypedDict):
configuredTable: ConfiguredTableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateConfiguredTableOutputTypeDef
# UpdateConfiguredTableOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableOutputTypeDef
def get_value() -> UpdateConfiguredTableOutputTypeDef:
return {
"configuredTable": ...,
"ResponseMetadata": ...,
}
# UpdateConfiguredTableOutputTypeDef definition
class UpdateConfiguredTableOutputTypeDef(TypedDict):
configuredTable: ConfiguredTableTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartProtectedQueryInputRequestTypeDef
# StartProtectedQueryInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import StartProtectedQueryInputRequestTypeDef
def get_value() -> StartProtectedQueryInputRequestTypeDef:
return {
"type": ...,
"membershipIdentifier": ...,
"sqlParameters": ...,
"resultConfiguration": ...,
}
# StartProtectedQueryInputRequestTypeDef definition
class StartProtectedQueryInputRequestTypeDef(TypedDict):
type: ProtectedQueryTypeType, # (1)
membershipIdentifier: str,
sqlParameters: ProtectedQuerySQLParametersTypeDef, # (2)
resultConfiguration: ProtectedQueryResultConfigurationTypeDef, # (3)
- See ProtectedQueryTypeType
- See ProtectedQuerySQLParametersTypeDef
- See ProtectedQueryResultConfigurationTypeDef
ProtectedQueryTypeDef
# ProtectedQueryTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryTypeDef
def get_value() -> ProtectedQueryTypeDef:
return {
"id": ...,
"membershipId": ...,
"membershipArn": ...,
"createTime": ...,
"sqlParameters": ...,
"status": ...,
"resultConfiguration": ...,
}
# ProtectedQueryTypeDef definition
class ProtectedQueryTypeDef(TypedDict):
id: str,
membershipId: str,
membershipArn: str,
createTime: datetime,
sqlParameters: ProtectedQuerySQLParametersTypeDef, # (1)
status: ProtectedQueryStatusType, # (2)
resultConfiguration: ProtectedQueryResultConfigurationTypeDef, # (3)
statistics: NotRequired[ProtectedQueryStatisticsTypeDef], # (4)
result: NotRequired[ProtectedQueryResultTypeDef], # (5)
error: NotRequired[ProtectedQueryErrorTypeDef], # (6)
- See ProtectedQuerySQLParametersTypeDef
- See ProtectedQueryStatusType
- See ProtectedQueryResultConfigurationTypeDef
- See ProtectedQueryStatisticsTypeDef
- See ProtectedQueryResultTypeDef
- See ProtectedQueryErrorTypeDef
AnalysisRuleTypeDef
# AnalysisRuleTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import AnalysisRuleTypeDef
def get_value() -> AnalysisRuleTypeDef:
return {
"collaborationId": ...,
"type": ...,
"name": ...,
"createTime": ...,
"updateTime": ...,
"policy": ...,
}
# AnalysisRuleTypeDef definition
class AnalysisRuleTypeDef(TypedDict):
collaborationId: str,
type: AnalysisRuleTypeType, # (1)
name: str,
createTime: datetime,
updateTime: datetime,
policy: AnalysisRulePolicyTypeDef, # (2)
ConfiguredTableAnalysisRuleTypeDef
# ConfiguredTableAnalysisRuleTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAnalysisRuleTypeDef
def get_value() -> ConfiguredTableAnalysisRuleTypeDef:
return {
"configuredTableId": ...,
"configuredTableArn": ...,
"policy": ...,
"type": ...,
"createTime": ...,
"updateTime": ...,
}
# ConfiguredTableAnalysisRuleTypeDef definition
class ConfiguredTableAnalysisRuleTypeDef(TypedDict):
configuredTableId: str,
configuredTableArn: str,
policy: ConfiguredTableAnalysisRulePolicyTypeDef, # (1)
type: ConfiguredTableAnalysisRuleTypeType, # (2)
createTime: datetime,
updateTime: datetime,
CreateConfiguredTableAnalysisRuleInputRequestTypeDef
# CreateConfiguredTableAnalysisRuleInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAnalysisRuleInputRequestTypeDef
def get_value() -> CreateConfiguredTableAnalysisRuleInputRequestTypeDef:
return {
"configuredTableIdentifier": ...,
"analysisRuleType": ...,
"analysisRulePolicy": ...,
}
# CreateConfiguredTableAnalysisRuleInputRequestTypeDef definition
class CreateConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef, # (2)
UpdateConfiguredTableAnalysisRuleInputRequestTypeDef
# UpdateConfiguredTableAnalysisRuleInputRequestTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAnalysisRuleInputRequestTypeDef
def get_value() -> UpdateConfiguredTableAnalysisRuleInputRequestTypeDef:
return {
"configuredTableIdentifier": ...,
"analysisRuleType": ...,
"analysisRulePolicy": ...,
}
# UpdateConfiguredTableAnalysisRuleInputRequestTypeDef definition
class UpdateConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef, # (2)
GetProtectedQueryOutputTypeDef
# GetProtectedQueryOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetProtectedQueryOutputTypeDef
def get_value() -> GetProtectedQueryOutputTypeDef:
return {
"protectedQuery": ...,
"ResponseMetadata": ...,
}
# GetProtectedQueryOutputTypeDef definition
class GetProtectedQueryOutputTypeDef(TypedDict):
protectedQuery: ProtectedQueryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
StartProtectedQueryOutputTypeDef
# StartProtectedQueryOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import StartProtectedQueryOutputTypeDef
def get_value() -> StartProtectedQueryOutputTypeDef:
return {
"protectedQuery": ...,
"ResponseMetadata": ...,
}
# StartProtectedQueryOutputTypeDef definition
class StartProtectedQueryOutputTypeDef(TypedDict):
protectedQuery: ProtectedQueryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateProtectedQueryOutputTypeDef
# UpdateProtectedQueryOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateProtectedQueryOutputTypeDef
def get_value() -> UpdateProtectedQueryOutputTypeDef:
return {
"protectedQuery": ...,
"ResponseMetadata": ...,
}
# UpdateProtectedQueryOutputTypeDef definition
class UpdateProtectedQueryOutputTypeDef(TypedDict):
protectedQuery: ProtectedQueryTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetSchemaAnalysisRuleOutputTypeDef
# GetSchemaAnalysisRuleOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetSchemaAnalysisRuleOutputTypeDef
def get_value() -> GetSchemaAnalysisRuleOutputTypeDef:
return {
"analysisRule": ...,
"ResponseMetadata": ...,
}
# GetSchemaAnalysisRuleOutputTypeDef definition
class GetSchemaAnalysisRuleOutputTypeDef(TypedDict):
analysisRule: AnalysisRuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
CreateConfiguredTableAnalysisRuleOutputTypeDef
# CreateConfiguredTableAnalysisRuleOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAnalysisRuleOutputTypeDef
def get_value() -> CreateConfiguredTableAnalysisRuleOutputTypeDef:
return {
"analysisRule": ...,
"ResponseMetadata": ...,
}
# CreateConfiguredTableAnalysisRuleOutputTypeDef definition
class CreateConfiguredTableAnalysisRuleOutputTypeDef(TypedDict):
analysisRule: ConfiguredTableAnalysisRuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
GetConfiguredTableAnalysisRuleOutputTypeDef
# GetConfiguredTableAnalysisRuleOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAnalysisRuleOutputTypeDef
def get_value() -> GetConfiguredTableAnalysisRuleOutputTypeDef:
return {
"analysisRule": ...,
"ResponseMetadata": ...,
}
# GetConfiguredTableAnalysisRuleOutputTypeDef definition
class GetConfiguredTableAnalysisRuleOutputTypeDef(TypedDict):
analysisRule: ConfiguredTableAnalysisRuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)
UpdateConfiguredTableAnalysisRuleOutputTypeDef
# UpdateConfiguredTableAnalysisRuleOutputTypeDef usage example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAnalysisRuleOutputTypeDef
def get_value() -> UpdateConfiguredTableAnalysisRuleOutputTypeDef:
return {
"analysisRule": ...,
"ResponseMetadata": ...,
}
# UpdateConfiguredTableAnalysisRuleOutputTypeDef definition
class UpdateConfiguredTableAnalysisRuleOutputTypeDef(TypedDict):
analysisRule: ConfiguredTableAnalysisRuleTypeDef, # (1)
ResponseMetadata: ResponseMetadataTypeDef, # (2)