Skip to content

Typed dictionaries

Index > CleanRoomsService > Typed dictionaries

Auto-generated documentation for CleanRoomsService type annotations stubs module mypy-boto3-cleanrooms.

AggregateColumnTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import AggregateColumnTypeDef

def get_value() -> AggregateColumnTypeDef:
    return {
        "columnNames": ...,
        "function": ...,
    }
Definition
class AggregateColumnTypeDef(TypedDict):
    columnNames: Sequence[str],
    function: AggregateFunctionNameType,  # (1)
  1. See AggregateFunctionNameType

AggregationConstraintTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import AggregationConstraintTypeDef

def get_value() -> AggregationConstraintTypeDef:
    return {
        "columnName": ...,
        "minimum": ...,
        "type": ...,
    }
Definition
class AggregationConstraintTypeDef(TypedDict):
    columnName: str,
    minimum: int,
    type: AggregationTypeType,  # (1)
  1. See AggregationTypeType

AnalysisRuleListTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import AnalysisRuleListTypeDef

def get_value() -> AnalysisRuleListTypeDef:
    return {
        "joinColumns": ...,
        "listColumns": ...,
    }
Definition
class AnalysisRuleListTypeDef(TypedDict):
    joinColumns: Sequence[str],
    listColumns: Sequence[str],

BatchGetSchemaErrorTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import BatchGetSchemaErrorTypeDef

def get_value() -> BatchGetSchemaErrorTypeDef:
    return {
        "name": ...,
        "code": ...,
        "message": ...,
    }
Definition
class BatchGetSchemaErrorTypeDef(TypedDict):
    name: str,
    code: str,
    message: str,

BatchGetSchemaInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import BatchGetSchemaInputRequestTypeDef

def get_value() -> BatchGetSchemaInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
        "names": ...,
    }
Definition
class BatchGetSchemaInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    names: Sequence[str],

ResponseMetadataTypeDef

Usage Example
from mypy_boto3_cleanrooms.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,

CollaborationSummaryTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CollaborationSummaryTypeDef

def get_value() -> CollaborationSummaryTypeDef:
    return {
        "id": ...,
        "arn": ...,
        "name": ...,
        "creatorAccountId": ...,
        "creatorDisplayName": ...,
        "createTime": ...,
        "updateTime": ...,
        "memberStatus": ...,
    }
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],
  1. See MemberStatusType

DataEncryptionMetadataTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import DataEncryptionMetadataTypeDef

def get_value() -> DataEncryptionMetadataTypeDef:
    return {
        "allowCleartext": ...,
        "allowDuplicates": ...,
        "allowJoinsOnColumnsWithDifferentNames": ...,
        "preserveNulls": ...,
    }
Definition
class DataEncryptionMetadataTypeDef(TypedDict):
    allowCleartext: bool,
    allowDuplicates: bool,
    allowJoinsOnColumnsWithDifferentNames: bool,
    preserveNulls: bool,

ColumnTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ColumnTypeDef

def get_value() -> ColumnTypeDef:
    return {
        "name": ...,
        "type": ...,
    }
Definition
class ColumnTypeDef(TypedDict):
    name: str,
    type: str,

ConfiguredTableAssociationSummaryTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAssociationSummaryTypeDef

def get_value() -> ConfiguredTableAssociationSummaryTypeDef:
    return {
        "configuredTableId": ...,
        "membershipId": ...,
        "membershipArn": ...,
        "name": ...,
        "createTime": ...,
        "updateTime": ...,
        "id": ...,
        "arn": ...,
    }
Definition
class ConfiguredTableAssociationSummaryTypeDef(TypedDict):
    configuredTableId: str,
    membershipId: str,
    membershipArn: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    id: str,
    arn: str,

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": ...,
    }
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

Usage Example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableSummaryTypeDef

def get_value() -> ConfiguredTableSummaryTypeDef:
    return {
        "id": ...,
        "arn": ...,
        "name": ...,
        "createTime": ...,
        "updateTime": ...,
        "analysisRuleTypes": ...,
        "analysisMethod": ...,
    }
Definition
class ConfiguredTableSummaryTypeDef(TypedDict):
    id: str,
    arn: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    analysisRuleTypes: List[ConfiguredTableAnalysisRuleTypeType],  # (1)
    analysisMethod: AnalysisMethodType,  # (2)
  1. See ConfiguredTableAnalysisRuleTypeType
  2. See AnalysisMethodType

MemberSpecificationTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import MemberSpecificationTypeDef

def get_value() -> MemberSpecificationTypeDef:
    return {
        "accountId": ...,
        "memberAbilities": ...,
        "displayName": ...,
    }
Definition
class MemberSpecificationTypeDef(TypedDict):
    accountId: str,
    memberAbilities: Sequence[MemberAbilityType],  # (1)
    displayName: str,
  1. See MemberAbilityType

CreateConfiguredTableAssociationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAssociationInputRequestTypeDef

def get_value() -> CreateConfiguredTableAssociationInputRequestTypeDef:
    return {
        "name": ...,
        "membershipIdentifier": ...,
        "configuredTableIdentifier": ...,
        "roleArn": ...,
    }
Definition
class CreateConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    name: str,
    membershipIdentifier: str,
    configuredTableIdentifier: str,
    roleArn: str,
    description: NotRequired[str],

CreateMembershipInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateMembershipInputRequestTypeDef

def get_value() -> CreateMembershipInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
        "queryLogStatus": ...,
    }
Definition
class CreateMembershipInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    queryLogStatus: MembershipQueryLogStatusType,  # (1)
  1. See MembershipQueryLogStatusType

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": ...,
    }
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)
  1. See MembershipStatusType
  2. See MemberAbilityType
  3. See MembershipQueryLogStatusType

DeleteCollaborationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import DeleteCollaborationInputRequestTypeDef

def get_value() -> DeleteCollaborationInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
    }
Definition
class DeleteCollaborationInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,

DeleteConfiguredTableAnalysisRuleInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import DeleteConfiguredTableAnalysisRuleInputRequestTypeDef

def get_value() -> DeleteConfiguredTableAnalysisRuleInputRequestTypeDef:
    return {
        "configuredTableIdentifier": ...,
        "analysisRuleType": ...,
    }
Definition
class DeleteConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
  1. See ConfiguredTableAnalysisRuleTypeType

DeleteConfiguredTableAssociationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import DeleteConfiguredTableAssociationInputRequestTypeDef

def get_value() -> DeleteConfiguredTableAssociationInputRequestTypeDef:
    return {
        "configuredTableAssociationIdentifier": ...,
        "membershipIdentifier": ...,
    }
Definition
class DeleteConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,

DeleteConfiguredTableInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import DeleteConfiguredTableInputRequestTypeDef

def get_value() -> DeleteConfiguredTableInputRequestTypeDef:
    return {
        "configuredTableIdentifier": ...,
    }
Definition
class DeleteConfiguredTableInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,

DeleteMemberInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import DeleteMemberInputRequestTypeDef

def get_value() -> DeleteMemberInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
        "accountId": ...,
    }
Definition
class DeleteMemberInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    accountId: str,

DeleteMembershipInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import DeleteMembershipInputRequestTypeDef

def get_value() -> DeleteMembershipInputRequestTypeDef:
    return {
        "membershipIdentifier": ...,
    }
Definition
class DeleteMembershipInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,

GetCollaborationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetCollaborationInputRequestTypeDef

def get_value() -> GetCollaborationInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
    }
Definition
class GetCollaborationInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,

GetConfiguredTableAnalysisRuleInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAnalysisRuleInputRequestTypeDef

def get_value() -> GetConfiguredTableAnalysisRuleInputRequestTypeDef:
    return {
        "configuredTableIdentifier": ...,
        "analysisRuleType": ...,
    }
Definition
class GetConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
  1. See ConfiguredTableAnalysisRuleTypeType

GetConfiguredTableAssociationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAssociationInputRequestTypeDef

def get_value() -> GetConfiguredTableAssociationInputRequestTypeDef:
    return {
        "configuredTableAssociationIdentifier": ...,
        "membershipIdentifier": ...,
    }
Definition
class GetConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,

GetConfiguredTableInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableInputRequestTypeDef

def get_value() -> GetConfiguredTableInputRequestTypeDef:
    return {
        "configuredTableIdentifier": ...,
    }
Definition
class GetConfiguredTableInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,

GetMembershipInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetMembershipInputRequestTypeDef

def get_value() -> GetMembershipInputRequestTypeDef:
    return {
        "membershipIdentifier": ...,
    }
Definition
class GetMembershipInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,

GetProtectedQueryInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetProtectedQueryInputRequestTypeDef

def get_value() -> GetProtectedQueryInputRequestTypeDef:
    return {
        "membershipIdentifier": ...,
        "protectedQueryIdentifier": ...,
    }
Definition
class GetProtectedQueryInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    protectedQueryIdentifier: str,

GetSchemaAnalysisRuleInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetSchemaAnalysisRuleInputRequestTypeDef

def get_value() -> GetSchemaAnalysisRuleInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
        "name": ...,
        "type": ...,
    }
Definition
class GetSchemaAnalysisRuleInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    name: str,
    type: AnalysisRuleTypeType,  # (1)
  1. See AnalysisRuleTypeType

GetSchemaInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetSchemaInputRequestTypeDef

def get_value() -> GetSchemaInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
        "name": ...,
    }
Definition
class GetSchemaInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    name: str,

GlueTableReferenceTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GlueTableReferenceTypeDef

def get_value() -> GlueTableReferenceTypeDef:
    return {
        "tableName": ...,
        "databaseName": ...,
    }
Definition
class GlueTableReferenceTypeDef(TypedDict):
    tableName: str,
    databaseName: str,

PaginatorConfigTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import PaginatorConfigTypeDef

def get_value() -> PaginatorConfigTypeDef:
    return {
        "MaxItems": ...,
    }
Definition
class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListCollaborationsInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListCollaborationsInputRequestTypeDef

def get_value() -> ListCollaborationsInputRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListCollaborationsInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    memberStatus: NotRequired[FilterableMemberStatusType],  # (1)
  1. See FilterableMemberStatusType

ListConfiguredTableAssociationsInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTableAssociationsInputRequestTypeDef

def get_value() -> ListConfiguredTableAssociationsInputRequestTypeDef:
    return {
        "membershipIdentifier": ...,
    }
Definition
class ListConfiguredTableAssociationsInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListConfiguredTablesInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTablesInputRequestTypeDef

def get_value() -> ListConfiguredTablesInputRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListConfiguredTablesInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListMembersInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListMembersInputRequestTypeDef

def get_value() -> ListMembersInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
    }
Definition
class ListMembersInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

MemberSummaryTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import MemberSummaryTypeDef

def get_value() -> MemberSummaryTypeDef:
    return {
        "accountId": ...,
        "status": ...,
        "displayName": ...,
        "abilities": ...,
        "createTime": ...,
        "updateTime": ...,
    }
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],
  1. See MemberStatusType
  2. See MemberAbilityType

ListMembershipsInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListMembershipsInputRequestTypeDef

def get_value() -> ListMembershipsInputRequestTypeDef:
    return {
        "nextToken": ...,
    }
Definition
class ListMembershipsInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    status: NotRequired[MembershipStatusType],  # (1)
  1. See MembershipStatusType

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": ...,
    }
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)
  1. See MembershipStatusType
  2. See MemberAbilityType

ListProtectedQueriesInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListProtectedQueriesInputRequestTypeDef

def get_value() -> ListProtectedQueriesInputRequestTypeDef:
    return {
        "membershipIdentifier": ...,
    }
Definition
class ListProtectedQueriesInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    status: NotRequired[ProtectedQueryStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ProtectedQueryStatusType

ProtectedQuerySummaryTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQuerySummaryTypeDef

def get_value() -> ProtectedQuerySummaryTypeDef:
    return {
        "id": ...,
        "membershipId": ...,
        "membershipArn": ...,
        "createTime": ...,
        "status": ...,
    }
Definition
class ProtectedQuerySummaryTypeDef(TypedDict):
    id: str,
    membershipId: str,
    membershipArn: str,
    createTime: datetime,
    status: ProtectedQueryStatusType,  # (1)
  1. See ProtectedQueryStatusType

ListSchemasInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListSchemasInputRequestTypeDef

def get_value() -> ListSchemasInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
    }
Definition
class ListSchemasInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    schemaType: NotRequired[SchemaTypeType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See SchemaTypeType

SchemaSummaryTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import SchemaSummaryTypeDef

def get_value() -> SchemaSummaryTypeDef:
    return {
        "name": ...,
        "type": ...,
        "creatorAccountId": ...,
        "createTime": ...,
        "updateTime": ...,
        "collaborationId": ...,
        "collaborationArn": ...,
        "analysisRuleTypes": ...,
    }
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)
  1. See SchemaTypeType
  2. See AnalysisRuleTypeType
  3. See AnalysisMethodType

ProtectedQueryErrorTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryErrorTypeDef

def get_value() -> ProtectedQueryErrorTypeDef:
    return {
        "message": ...,
        "code": ...,
    }
Definition
class ProtectedQueryErrorTypeDef(TypedDict):
    message: str,
    code: str,

ProtectedQueryS3OutputConfigurationTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryS3OutputConfigurationTypeDef

def get_value() -> ProtectedQueryS3OutputConfigurationTypeDef:
    return {
        "resultFormat": ...,
        "bucket": ...,
    }
Definition
class ProtectedQueryS3OutputConfigurationTypeDef(TypedDict):
    resultFormat: ResultFormatType,  # (1)
    bucket: str,
    keyPrefix: NotRequired[str],
  1. See ResultFormatType

ProtectedQueryS3OutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryS3OutputTypeDef

def get_value() -> ProtectedQueryS3OutputTypeDef:
    return {
        "location": ...,
    }
Definition
class ProtectedQueryS3OutputTypeDef(TypedDict):
    location: str,

ProtectedQuerySQLParametersTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQuerySQLParametersTypeDef

def get_value() -> ProtectedQuerySQLParametersTypeDef:
    return {
        "queryString": ...,
    }
Definition
class ProtectedQuerySQLParametersTypeDef(TypedDict):
    queryString: str,

ProtectedQueryStatisticsTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryStatisticsTypeDef

def get_value() -> ProtectedQueryStatisticsTypeDef:
    return {
        "totalDurationInMillis": ...,
    }
Definition
class ProtectedQueryStatisticsTypeDef(TypedDict):
    totalDurationInMillis: NotRequired[int],

UpdateCollaborationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateCollaborationInputRequestTypeDef

def get_value() -> UpdateCollaborationInputRequestTypeDef:
    return {
        "collaborationIdentifier": ...,
    }
Definition
class UpdateCollaborationInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    name: NotRequired[str],
    description: NotRequired[str],

UpdateConfiguredTableAssociationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAssociationInputRequestTypeDef

def get_value() -> UpdateConfiguredTableAssociationInputRequestTypeDef:
    return {
        "configuredTableAssociationIdentifier": ...,
        "membershipIdentifier": ...,
    }
Definition
class UpdateConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,
    description: NotRequired[str],
    roleArn: NotRequired[str],

UpdateConfiguredTableInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableInputRequestTypeDef

def get_value() -> UpdateConfiguredTableInputRequestTypeDef:
    return {
        "configuredTableIdentifier": ...,
    }
Definition
class UpdateConfiguredTableInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    name: NotRequired[str],
    description: NotRequired[str],

UpdateMembershipInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateMembershipInputRequestTypeDef

def get_value() -> UpdateMembershipInputRequestTypeDef:
    return {
        "membershipIdentifier": ...,
    }
Definition
class UpdateMembershipInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    queryLogStatus: NotRequired[MembershipQueryLogStatusType],  # (1)
  1. See MembershipQueryLogStatusType

UpdateProtectedQueryInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateProtectedQueryInputRequestTypeDef

def get_value() -> UpdateProtectedQueryInputRequestTypeDef:
    return {
        "membershipIdentifier": ...,
        "protectedQueryIdentifier": ...,
        "targetStatus": ...,
    }
Definition
class UpdateProtectedQueryInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    protectedQueryIdentifier: str,
    targetStatus: TargetProtectedQueryStatusType,  # (1)
  1. See TargetProtectedQueryStatusType

AnalysisRuleAggregationTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import AnalysisRuleAggregationTypeDef

def get_value() -> AnalysisRuleAggregationTypeDef:
    return {
        "aggregateColumns": ...,
        "joinColumns": ...,
        "dimensionColumns": ...,
        "scalarFunctions": ...,
        "outputConstraints": ...,
    }
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)
  1. See AggregateColumnTypeDef
  2. See JoinRequiredOptionType
  3. See ScalarFunctionsType
  4. See AggregationConstraintTypeDef

ListCollaborationsOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListCollaborationsOutputTypeDef

def get_value() -> ListCollaborationsOutputTypeDef:
    return {
        "nextToken": ...,
        "collaborationList": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListCollaborationsOutputTypeDef(TypedDict):
    nextToken: str,
    collaborationList: List[CollaborationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationSummaryTypeDef
  2. See ResponseMetadataTypeDef

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": ...,
    }
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)
  1. See MemberStatusType
  2. See DataEncryptionMetadataTypeDef
  3. See CollaborationQueryLogStatusType

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": ...,
    }
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)
  1. See ColumnTypeDef
  2. See ColumnTypeDef
  3. See AnalysisRuleTypeType
  4. See AnalysisMethodType
  5. See SchemaTypeType

ListConfiguredTableAssociationsOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTableAssociationsOutputTypeDef

def get_value() -> ListConfiguredTableAssociationsOutputTypeDef:
    return {
        "configuredTableAssociationSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListConfiguredTableAssociationsOutputTypeDef(TypedDict):
    configuredTableAssociationSummaries: List[ConfiguredTableAssociationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateConfiguredTableAssociationOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAssociationOutputTypeDef

def get_value() -> CreateConfiguredTableAssociationOutputTypeDef:
    return {
        "configuredTableAssociation": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateConfiguredTableAssociationOutputTypeDef(TypedDict):
    configuredTableAssociation: ConfiguredTableAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationTypeDef
  2. See ResponseMetadataTypeDef

GetConfiguredTableAssociationOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAssociationOutputTypeDef

def get_value() -> GetConfiguredTableAssociationOutputTypeDef:
    return {
        "configuredTableAssociation": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetConfiguredTableAssociationOutputTypeDef(TypedDict):
    configuredTableAssociation: ConfiguredTableAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationTypeDef
  2. See ResponseMetadataTypeDef

UpdateConfiguredTableAssociationOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAssociationOutputTypeDef

def get_value() -> UpdateConfiguredTableAssociationOutputTypeDef:
    return {
        "configuredTableAssociation": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateConfiguredTableAssociationOutputTypeDef(TypedDict):
    configuredTableAssociation: ConfiguredTableAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationTypeDef
  2. See ResponseMetadataTypeDef

ListConfiguredTablesOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTablesOutputTypeDef

def get_value() -> ListConfiguredTablesOutputTypeDef:
    return {
        "configuredTableSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListConfiguredTablesOutputTypeDef(TypedDict):
    configuredTableSummaries: List[ConfiguredTableSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateCollaborationInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateCollaborationInputRequestTypeDef

def get_value() -> CreateCollaborationInputRequestTypeDef:
    return {
        "members": ...,
        "name": ...,
        "description": ...,
        "creatorMemberAbilities": ...,
        "creatorDisplayName": ...,
        "queryLogStatus": ...,
    }
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)
  1. See MemberSpecificationTypeDef
  2. See MemberAbilityType
  3. See CollaborationQueryLogStatusType
  4. See DataEncryptionMetadataTypeDef

CreateMembershipOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateMembershipOutputTypeDef

def get_value() -> CreateMembershipOutputTypeDef:
    return {
        "membership": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateMembershipOutputTypeDef(TypedDict):
    membership: MembershipTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MembershipTypeDef
  2. See ResponseMetadataTypeDef

GetMembershipOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetMembershipOutputTypeDef

def get_value() -> GetMembershipOutputTypeDef:
    return {
        "membership": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetMembershipOutputTypeDef(TypedDict):
    membership: MembershipTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MembershipTypeDef
  2. See ResponseMetadataTypeDef

UpdateMembershipOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateMembershipOutputTypeDef

def get_value() -> UpdateMembershipOutputTypeDef:
    return {
        "membership": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateMembershipOutputTypeDef(TypedDict):
    membership: MembershipTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MembershipTypeDef
  2. See ResponseMetadataTypeDef

TableReferenceTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import TableReferenceTypeDef

def get_value() -> TableReferenceTypeDef:
    return {
        "glue": ...,
    }
Definition
class TableReferenceTypeDef(TypedDict):
    glue: NotRequired[GlueTableReferenceTypeDef],  # (1)
  1. See GlueTableReferenceTypeDef

ListCollaborationsInputListCollaborationsPaginateTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListCollaborationsInputListCollaborationsPaginateTypeDef

def get_value() -> ListCollaborationsInputListCollaborationsPaginateTypeDef:
    return {
        "memberStatus": ...,
    }
Definition
class ListCollaborationsInputListCollaborationsPaginateTypeDef(TypedDict):
    memberStatus: NotRequired[FilterableMemberStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterableMemberStatusType
  2. See PaginatorConfigTypeDef

ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef

def get_value() -> ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef:
    return {
        "membershipIdentifier": ...,
    }
Definition
class ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef(TypedDict):
    membershipIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef

def get_value() -> ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef:
    return {
        "PaginationConfig": ...,
    }
Definition
class ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMembersInputListMembersPaginateTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListMembersInputListMembersPaginateTypeDef

def get_value() -> ListMembersInputListMembersPaginateTypeDef:
    return {
        "collaborationIdentifier": ...,
    }
Definition
class ListMembersInputListMembersPaginateTypeDef(TypedDict):
    collaborationIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMembershipsInputListMembershipsPaginateTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListMembershipsInputListMembershipsPaginateTypeDef

def get_value() -> ListMembershipsInputListMembershipsPaginateTypeDef:
    return {
        "status": ...,
    }
Definition
class ListMembershipsInputListMembershipsPaginateTypeDef(TypedDict):
    status: NotRequired[MembershipStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See MembershipStatusType
  2. See PaginatorConfigTypeDef

ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef

def get_value() -> ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef:
    return {
        "membershipIdentifier": ...,
    }
Definition
class ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef(TypedDict):
    membershipIdentifier: str,
    status: NotRequired[ProtectedQueryStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ProtectedQueryStatusType
  2. See PaginatorConfigTypeDef

ListSchemasInputListSchemasPaginateTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListSchemasInputListSchemasPaginateTypeDef

def get_value() -> ListSchemasInputListSchemasPaginateTypeDef:
    return {
        "collaborationIdentifier": ...,
    }
Definition
class ListSchemasInputListSchemasPaginateTypeDef(TypedDict):
    collaborationIdentifier: str,
    schemaType: NotRequired[SchemaTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SchemaTypeType
  2. See PaginatorConfigTypeDef

ListMembersOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListMembersOutputTypeDef

def get_value() -> ListMembersOutputTypeDef:
    return {
        "nextToken": ...,
        "memberSummaries": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListMembersOutputTypeDef(TypedDict):
    nextToken: str,
    memberSummaries: List[MemberSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MemberSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListMembershipsOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListMembershipsOutputTypeDef

def get_value() -> ListMembershipsOutputTypeDef:
    return {
        "nextToken": ...,
        "membershipSummaries": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListMembershipsOutputTypeDef(TypedDict):
    nextToken: str,
    membershipSummaries: List[MembershipSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MembershipSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListProtectedQueriesOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListProtectedQueriesOutputTypeDef

def get_value() -> ListProtectedQueriesOutputTypeDef:
    return {
        "nextToken": ...,
        "protectedQueries": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListProtectedQueriesOutputTypeDef(TypedDict):
    nextToken: str,
    protectedQueries: List[ProtectedQuerySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProtectedQuerySummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSchemasOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ListSchemasOutputTypeDef

def get_value() -> ListSchemasOutputTypeDef:
    return {
        "schemaSummaries": ...,
        "nextToken": ...,
        "ResponseMetadata": ...,
    }
Definition
class ListSchemasOutputTypeDef(TypedDict):
    schemaSummaries: List[SchemaSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaSummaryTypeDef
  2. See ResponseMetadataTypeDef

ProtectedQueryOutputConfigurationTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryOutputConfigurationTypeDef

def get_value() -> ProtectedQueryOutputConfigurationTypeDef:
    return {
        "s3": ...,
    }
Definition
class ProtectedQueryOutputConfigurationTypeDef(TypedDict):
    s3: NotRequired[ProtectedQueryS3OutputConfigurationTypeDef],  # (1)
  1. See ProtectedQueryS3OutputConfigurationTypeDef

ProtectedQueryOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryOutputTypeDef

def get_value() -> ProtectedQueryOutputTypeDef:
    return {
        "s3": ...,
    }
Definition
class ProtectedQueryOutputTypeDef(TypedDict):
    s3: NotRequired[ProtectedQueryS3OutputTypeDef],  # (1)
  1. See ProtectedQueryS3OutputTypeDef

AnalysisRulePolicyV1TypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import AnalysisRulePolicyV1TypeDef

def get_value() -> AnalysisRulePolicyV1TypeDef:
    return {
        "list": ...,
    }
Definition
class AnalysisRulePolicyV1TypeDef(TypedDict):
    list: NotRequired[AnalysisRuleListTypeDef],  # (1)
    aggregation: NotRequired[AnalysisRuleAggregationTypeDef],  # (2)
  1. See AnalysisRuleListTypeDef
  2. See AnalysisRuleAggregationTypeDef

ConfiguredTableAnalysisRulePolicyV1TypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAnalysisRulePolicyV1TypeDef

def get_value() -> ConfiguredTableAnalysisRulePolicyV1TypeDef:
    return {
        "list": ...,
    }
Definition
class ConfiguredTableAnalysisRulePolicyV1TypeDef(TypedDict):
    list: NotRequired[AnalysisRuleListTypeDef],  # (1)
    aggregation: NotRequired[AnalysisRuleAggregationTypeDef],  # (2)
  1. See AnalysisRuleListTypeDef
  2. See AnalysisRuleAggregationTypeDef

CreateCollaborationOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateCollaborationOutputTypeDef

def get_value() -> CreateCollaborationOutputTypeDef:
    return {
        "collaboration": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateCollaborationOutputTypeDef(TypedDict):
    collaboration: CollaborationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationTypeDef
  2. See ResponseMetadataTypeDef

GetCollaborationOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetCollaborationOutputTypeDef

def get_value() -> GetCollaborationOutputTypeDef:
    return {
        "collaboration": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetCollaborationOutputTypeDef(TypedDict):
    collaboration: CollaborationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationTypeDef
  2. See ResponseMetadataTypeDef

UpdateCollaborationOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateCollaborationOutputTypeDef

def get_value() -> UpdateCollaborationOutputTypeDef:
    return {
        "collaboration": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateCollaborationOutputTypeDef(TypedDict):
    collaboration: CollaborationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationTypeDef
  2. See ResponseMetadataTypeDef

BatchGetSchemaOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import BatchGetSchemaOutputTypeDef

def get_value() -> BatchGetSchemaOutputTypeDef:
    return {
        "schemas": ...,
        "errors": ...,
        "ResponseMetadata": ...,
    }
Definition
class BatchGetSchemaOutputTypeDef(TypedDict):
    schemas: List[SchemaTypeDef],  # (1)
    errors: List[BatchGetSchemaErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See SchemaTypeDef
  2. See BatchGetSchemaErrorTypeDef
  3. See ResponseMetadataTypeDef

GetSchemaOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetSchemaOutputTypeDef

def get_value() -> GetSchemaOutputTypeDef:
    return {
        "schema": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetSchemaOutputTypeDef(TypedDict):
    schema: SchemaTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaTypeDef
  2. See ResponseMetadataTypeDef

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": ...,
    }
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],
  1. See TableReferenceTypeDef
  2. See ConfiguredTableAnalysisRuleTypeType
  3. See AnalysisMethodType

CreateConfiguredTableInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableInputRequestTypeDef

def get_value() -> CreateConfiguredTableInputRequestTypeDef:
    return {
        "name": ...,
        "tableReference": ...,
        "allowedColumns": ...,
        "analysisMethod": ...,
    }
Definition
class CreateConfiguredTableInputRequestTypeDef(TypedDict):
    name: str,
    tableReference: TableReferenceTypeDef,  # (1)
    allowedColumns: Sequence[str],
    analysisMethod: AnalysisMethodType,  # (2)
    description: NotRequired[str],
  1. See TableReferenceTypeDef
  2. See AnalysisMethodType

ProtectedQueryResultConfigurationTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryResultConfigurationTypeDef

def get_value() -> ProtectedQueryResultConfigurationTypeDef:
    return {
        "outputConfiguration": ...,
    }
Definition
class ProtectedQueryResultConfigurationTypeDef(TypedDict):
    outputConfiguration: ProtectedQueryOutputConfigurationTypeDef,  # (1)
  1. See ProtectedQueryOutputConfigurationTypeDef

ProtectedQueryResultTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryResultTypeDef

def get_value() -> ProtectedQueryResultTypeDef:
    return {
        "output": ...,
    }
Definition
class ProtectedQueryResultTypeDef(TypedDict):
    output: ProtectedQueryOutputTypeDef,  # (1)
  1. See ProtectedQueryOutputTypeDef

AnalysisRulePolicyTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import AnalysisRulePolicyTypeDef

def get_value() -> AnalysisRulePolicyTypeDef:
    return {
        "v1": ...,
    }
Definition
class AnalysisRulePolicyTypeDef(TypedDict):
    v1: NotRequired[AnalysisRulePolicyV1TypeDef],  # (1)
  1. See AnalysisRulePolicyV1TypeDef

ConfiguredTableAnalysisRulePolicyTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAnalysisRulePolicyTypeDef

def get_value() -> ConfiguredTableAnalysisRulePolicyTypeDef:
    return {
        "v1": ...,
    }
Definition
class ConfiguredTableAnalysisRulePolicyTypeDef(TypedDict):
    v1: NotRequired[ConfiguredTableAnalysisRulePolicyV1TypeDef],  # (1)
  1. See ConfiguredTableAnalysisRulePolicyV1TypeDef

CreateConfiguredTableOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableOutputTypeDef

def get_value() -> CreateConfiguredTableOutputTypeDef:
    return {
        "configuredTable": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateConfiguredTableOutputTypeDef(TypedDict):
    configuredTable: ConfiguredTableTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableTypeDef
  2. See ResponseMetadataTypeDef

GetConfiguredTableOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableOutputTypeDef

def get_value() -> GetConfiguredTableOutputTypeDef:
    return {
        "configuredTable": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetConfiguredTableOutputTypeDef(TypedDict):
    configuredTable: ConfiguredTableTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableTypeDef
  2. See ResponseMetadataTypeDef

UpdateConfiguredTableOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableOutputTypeDef

def get_value() -> UpdateConfiguredTableOutputTypeDef:
    return {
        "configuredTable": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateConfiguredTableOutputTypeDef(TypedDict):
    configuredTable: ConfiguredTableTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableTypeDef
  2. See ResponseMetadataTypeDef

StartProtectedQueryInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import StartProtectedQueryInputRequestTypeDef

def get_value() -> StartProtectedQueryInputRequestTypeDef:
    return {
        "type": ...,
        "membershipIdentifier": ...,
        "sqlParameters": ...,
        "resultConfiguration": ...,
    }
Definition
class StartProtectedQueryInputRequestTypeDef(TypedDict):
    type: ProtectedQueryTypeType,  # (1)
    membershipIdentifier: str,
    sqlParameters: ProtectedQuerySQLParametersTypeDef,  # (2)
    resultConfiguration: ProtectedQueryResultConfigurationTypeDef,  # (3)
  1. See ProtectedQueryTypeType
  2. See ProtectedQuerySQLParametersTypeDef
  3. See ProtectedQueryResultConfigurationTypeDef

ProtectedQueryTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ProtectedQueryTypeDef

def get_value() -> ProtectedQueryTypeDef:
    return {
        "id": ...,
        "membershipId": ...,
        "membershipArn": ...,
        "createTime": ...,
        "sqlParameters": ...,
        "status": ...,
        "resultConfiguration": ...,
    }
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)
  1. See ProtectedQuerySQLParametersTypeDef
  2. See ProtectedQueryStatusType
  3. See ProtectedQueryResultConfigurationTypeDef
  4. See ProtectedQueryStatisticsTypeDef
  5. See ProtectedQueryResultTypeDef
  6. See ProtectedQueryErrorTypeDef

AnalysisRuleTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import AnalysisRuleTypeDef

def get_value() -> AnalysisRuleTypeDef:
    return {
        "collaborationId": ...,
        "type": ...,
        "name": ...,
        "createTime": ...,
        "updateTime": ...,
        "policy": ...,
    }
Definition
class AnalysisRuleTypeDef(TypedDict):
    collaborationId: str,
    type: AnalysisRuleTypeType,  # (1)
    name: str,
    createTime: datetime,
    updateTime: datetime,
    policy: AnalysisRulePolicyTypeDef,  # (2)
  1. See AnalysisRuleTypeType
  2. See AnalysisRulePolicyTypeDef

ConfiguredTableAnalysisRuleTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import ConfiguredTableAnalysisRuleTypeDef

def get_value() -> ConfiguredTableAnalysisRuleTypeDef:
    return {
        "configuredTableId": ...,
        "configuredTableArn": ...,
        "policy": ...,
        "type": ...,
        "createTime": ...,
        "updateTime": ...,
    }
Definition
class ConfiguredTableAnalysisRuleTypeDef(TypedDict):
    configuredTableId: str,
    configuredTableArn: str,
    policy: ConfiguredTableAnalysisRulePolicyTypeDef,  # (1)
    type: ConfiguredTableAnalysisRuleTypeType,  # (2)
    createTime: datetime,
    updateTime: datetime,
  1. See ConfiguredTableAnalysisRulePolicyTypeDef
  2. See ConfiguredTableAnalysisRuleTypeType

CreateConfiguredTableAnalysisRuleInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAnalysisRuleInputRequestTypeDef

def get_value() -> CreateConfiguredTableAnalysisRuleInputRequestTypeDef:
    return {
        "configuredTableIdentifier": ...,
        "analysisRuleType": ...,
        "analysisRulePolicy": ...,
    }
Definition
class CreateConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
    analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef,  # (2)
  1. See ConfiguredTableAnalysisRuleTypeType
  2. See ConfiguredTableAnalysisRulePolicyTypeDef

UpdateConfiguredTableAnalysisRuleInputRequestTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAnalysisRuleInputRequestTypeDef

def get_value() -> UpdateConfiguredTableAnalysisRuleInputRequestTypeDef:
    return {
        "configuredTableIdentifier": ...,
        "analysisRuleType": ...,
        "analysisRulePolicy": ...,
    }
Definition
class UpdateConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
    analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef,  # (2)
  1. See ConfiguredTableAnalysisRuleTypeType
  2. See ConfiguredTableAnalysisRulePolicyTypeDef

GetProtectedQueryOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetProtectedQueryOutputTypeDef

def get_value() -> GetProtectedQueryOutputTypeDef:
    return {
        "protectedQuery": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetProtectedQueryOutputTypeDef(TypedDict):
    protectedQuery: ProtectedQueryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProtectedQueryTypeDef
  2. See ResponseMetadataTypeDef

StartProtectedQueryOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import StartProtectedQueryOutputTypeDef

def get_value() -> StartProtectedQueryOutputTypeDef:
    return {
        "protectedQuery": ...,
        "ResponseMetadata": ...,
    }
Definition
class StartProtectedQueryOutputTypeDef(TypedDict):
    protectedQuery: ProtectedQueryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProtectedQueryTypeDef
  2. See ResponseMetadataTypeDef

UpdateProtectedQueryOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateProtectedQueryOutputTypeDef

def get_value() -> UpdateProtectedQueryOutputTypeDef:
    return {
        "protectedQuery": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateProtectedQueryOutputTypeDef(TypedDict):
    protectedQuery: ProtectedQueryTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProtectedQueryTypeDef
  2. See ResponseMetadataTypeDef

GetSchemaAnalysisRuleOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetSchemaAnalysisRuleOutputTypeDef

def get_value() -> GetSchemaAnalysisRuleOutputTypeDef:
    return {
        "analysisRule": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetSchemaAnalysisRuleOutputTypeDef(TypedDict):
    analysisRule: AnalysisRuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisRuleTypeDef
  2. See ResponseMetadataTypeDef

CreateConfiguredTableAnalysisRuleOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import CreateConfiguredTableAnalysisRuleOutputTypeDef

def get_value() -> CreateConfiguredTableAnalysisRuleOutputTypeDef:
    return {
        "analysisRule": ...,
        "ResponseMetadata": ...,
    }
Definition
class CreateConfiguredTableAnalysisRuleOutputTypeDef(TypedDict):
    analysisRule: ConfiguredTableAnalysisRuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAnalysisRuleTypeDef
  2. See ResponseMetadataTypeDef

GetConfiguredTableAnalysisRuleOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import GetConfiguredTableAnalysisRuleOutputTypeDef

def get_value() -> GetConfiguredTableAnalysisRuleOutputTypeDef:
    return {
        "analysisRule": ...,
        "ResponseMetadata": ...,
    }
Definition
class GetConfiguredTableAnalysisRuleOutputTypeDef(TypedDict):
    analysisRule: ConfiguredTableAnalysisRuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAnalysisRuleTypeDef
  2. See ResponseMetadataTypeDef

UpdateConfiguredTableAnalysisRuleOutputTypeDef

Usage Example
from mypy_boto3_cleanrooms.type_defs import UpdateConfiguredTableAnalysisRuleOutputTypeDef

def get_value() -> UpdateConfiguredTableAnalysisRuleOutputTypeDef:
    return {
        "analysisRule": ...,
        "ResponseMetadata": ...,
    }
Definition
class UpdateConfiguredTableAnalysisRuleOutputTypeDef(TypedDict):
    analysisRule: ConfiguredTableAnalysisRuleTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAnalysisRuleTypeDef
  2. See ResponseMetadataTypeDef