Skip to content

Type definitions#

Index > CleanRoomsService > Type definitions

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

AggregateColumnTypeDef#

# AggregateColumnTypeDef definition

class AggregateColumnTypeDef(TypedDict):
    columnNames: Sequence[str],
    function: AggregateFunctionNameType,  # (1)
  1. See AggregateFunctionNameType

AggregationConstraintTypeDef#

# AggregationConstraintTypeDef definition

class AggregationConstraintTypeDef(TypedDict):
    columnName: str,
    minimum: int,
    type: AggregationTypeType,  # (1)
  1. See AggregationTypeType

AnalysisParameterTypeDef#

# AnalysisParameterTypeDef definition

class AnalysisParameterTypeDef(TypedDict):
    name: str,
    type: ParameterTypeType,  # (1)
    defaultValue: NotRequired[str],
  1. See ParameterTypeType

AnalysisRuleCustomTypeDef#

# AnalysisRuleCustomTypeDef definition

class AnalysisRuleCustomTypeDef(TypedDict):
    allowedAnalyses: Sequence[str],
    allowedAnalysisProviders: NotRequired[Sequence[str]],

AnalysisRuleListTypeDef#

# AnalysisRuleListTypeDef definition

class AnalysisRuleListTypeDef(TypedDict):
    joinColumns: Sequence[str],
    listColumns: Sequence[str],
    allowedJoinOperators: NotRequired[Sequence[JoinOperatorType]],  # (1)
  1. See JoinOperatorType

AnalysisSchemaTypeDef#

# AnalysisSchemaTypeDef definition

class AnalysisSchemaTypeDef(TypedDict):
    referencedTables: NotRequired[List[str]],

AnalysisSourceTypeDef#

# AnalysisSourceTypeDef definition

class AnalysisSourceTypeDef(TypedDict):
    text: NotRequired[str],

AnalysisTemplateSummaryTypeDef#

# AnalysisTemplateSummaryTypeDef definition

class AnalysisTemplateSummaryTypeDef(TypedDict):
    arn: str,
    createTime: datetime,
    id: str,
    name: str,
    updateTime: datetime,
    membershipArn: str,
    membershipId: str,
    collaborationArn: str,
    collaborationId: str,
    description: NotRequired[str],

BatchGetCollaborationAnalysisTemplateErrorTypeDef#

# BatchGetCollaborationAnalysisTemplateErrorTypeDef definition

class BatchGetCollaborationAnalysisTemplateErrorTypeDef(TypedDict):
    arn: str,
    code: str,
    message: str,

BatchGetCollaborationAnalysisTemplateInputRequestTypeDef#

# BatchGetCollaborationAnalysisTemplateInputRequestTypeDef definition

class BatchGetCollaborationAnalysisTemplateInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    analysisTemplateArns: Sequence[str],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HostId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,

BatchGetSchemaErrorTypeDef#

# BatchGetSchemaErrorTypeDef definition

class BatchGetSchemaErrorTypeDef(TypedDict):
    name: str,
    code: str,
    message: str,

BatchGetSchemaInputRequestTypeDef#

# BatchGetSchemaInputRequestTypeDef definition

class BatchGetSchemaInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    names: Sequence[str],

CollaborationAnalysisTemplateSummaryTypeDef#

# CollaborationAnalysisTemplateSummaryTypeDef definition

class CollaborationAnalysisTemplateSummaryTypeDef(TypedDict):
    arn: str,
    createTime: datetime,
    id: str,
    name: str,
    updateTime: datetime,
    collaborationArn: str,
    collaborationId: str,
    creatorAccountId: str,
    description: NotRequired[str],

CollaborationSummaryTypeDef#

# 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],
  1. See MemberStatusType

DataEncryptionMetadataTypeDef#

# DataEncryptionMetadataTypeDef definition

class DataEncryptionMetadataTypeDef(TypedDict):
    allowCleartext: bool,
    allowDuplicates: bool,
    allowJoinsOnColumnsWithDifferentNames: bool,
    preserveNulls: bool,

ColumnTypeDef#

# ColumnTypeDef definition

class ColumnTypeDef(TypedDict):
    name: str,
    type: str,

ConfiguredTableAssociationSummaryTypeDef#

# ConfiguredTableAssociationSummaryTypeDef definition

class ConfiguredTableAssociationSummaryTypeDef(TypedDict):
    configuredTableId: str,
    membershipId: str,
    membershipArn: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    id: str,
    arn: str,

ConfiguredTableAssociationTypeDef#

# 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 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#

# MemberSpecificationTypeDef definition

class MemberSpecificationTypeDef(TypedDict):
    accountId: str,
    memberAbilities: Sequence[MemberAbilityType],  # (1)
    displayName: str,
  1. See MemberAbilityType

CreateConfiguredTableAssociationInputRequestTypeDef#

# CreateConfiguredTableAssociationInputRequestTypeDef definition

class CreateConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    name: str,
    membershipIdentifier: str,
    configuredTableIdentifier: str,
    roleArn: str,
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],

DeleteAnalysisTemplateInputRequestTypeDef#

# DeleteAnalysisTemplateInputRequestTypeDef definition

class DeleteAnalysisTemplateInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    analysisTemplateIdentifier: str,

DeleteCollaborationInputRequestTypeDef#

# DeleteCollaborationInputRequestTypeDef definition

class DeleteCollaborationInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,

DeleteConfiguredTableAnalysisRuleInputRequestTypeDef#

# DeleteConfiguredTableAnalysisRuleInputRequestTypeDef definition

class DeleteConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
  1. See ConfiguredTableAnalysisRuleTypeType

DeleteConfiguredTableAssociationInputRequestTypeDef#

# DeleteConfiguredTableAssociationInputRequestTypeDef definition

class DeleteConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,

DeleteConfiguredTableInputRequestTypeDef#

# DeleteConfiguredTableInputRequestTypeDef definition

class DeleteConfiguredTableInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,

DeleteMemberInputRequestTypeDef#

# DeleteMemberInputRequestTypeDef definition

class DeleteMemberInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    accountId: str,

DeleteMembershipInputRequestTypeDef#

# DeleteMembershipInputRequestTypeDef definition

class DeleteMembershipInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,

GetAnalysisTemplateInputRequestTypeDef#

# GetAnalysisTemplateInputRequestTypeDef definition

class GetAnalysisTemplateInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    analysisTemplateIdentifier: str,

GetCollaborationAnalysisTemplateInputRequestTypeDef#

# GetCollaborationAnalysisTemplateInputRequestTypeDef definition

class GetCollaborationAnalysisTemplateInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    analysisTemplateArn: str,

GetCollaborationInputRequestTypeDef#

# GetCollaborationInputRequestTypeDef definition

class GetCollaborationInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,

GetConfiguredTableAnalysisRuleInputRequestTypeDef#

# GetConfiguredTableAnalysisRuleInputRequestTypeDef definition

class GetConfiguredTableAnalysisRuleInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
  1. See ConfiguredTableAnalysisRuleTypeType

GetConfiguredTableAssociationInputRequestTypeDef#

# GetConfiguredTableAssociationInputRequestTypeDef definition

class GetConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,

GetConfiguredTableInputRequestTypeDef#

# GetConfiguredTableInputRequestTypeDef definition

class GetConfiguredTableInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,

GetMembershipInputRequestTypeDef#

# GetMembershipInputRequestTypeDef definition

class GetMembershipInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,

GetProtectedQueryInputRequestTypeDef#

# GetProtectedQueryInputRequestTypeDef definition

class GetProtectedQueryInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    protectedQueryIdentifier: str,

GetSchemaAnalysisRuleInputRequestTypeDef#

# GetSchemaAnalysisRuleInputRequestTypeDef definition

class GetSchemaAnalysisRuleInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    name: str,
    type: AnalysisRuleTypeType,  # (1)
  1. See AnalysisRuleTypeType

GetSchemaInputRequestTypeDef#

# GetSchemaInputRequestTypeDef definition

class GetSchemaInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    name: str,

GlueTableReferenceTypeDef#

# GlueTableReferenceTypeDef definition

class GlueTableReferenceTypeDef(TypedDict):
    tableName: str,
    databaseName: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAnalysisTemplatesInputRequestTypeDef#

# ListAnalysisTemplatesInputRequestTypeDef definition

class ListAnalysisTemplatesInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListCollaborationAnalysisTemplatesInputRequestTypeDef#

# ListCollaborationAnalysisTemplatesInputRequestTypeDef definition

class ListCollaborationAnalysisTemplatesInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListCollaborationsInputRequestTypeDef#

# ListCollaborationsInputRequestTypeDef definition

class ListCollaborationsInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    memberStatus: NotRequired[FilterableMemberStatusType],  # (1)
  1. See FilterableMemberStatusType

ListConfiguredTableAssociationsInputRequestTypeDef#

# ListConfiguredTableAssociationsInputRequestTypeDef definition

class ListConfiguredTableAssociationsInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListConfiguredTablesInputRequestTypeDef#

# ListConfiguredTablesInputRequestTypeDef definition

class ListConfiguredTablesInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

ListMembersInputRequestTypeDef#

# ListMembersInputRequestTypeDef definition

class ListMembersInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],

MemberSummaryTypeDef#

# 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],
  1. See MemberStatusType
  2. See MemberAbilityType

ListMembershipsInputRequestTypeDef#

# ListMembershipsInputRequestTypeDef definition

class ListMembershipsInputRequestTypeDef(TypedDict):
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    status: NotRequired[MembershipStatusType],  # (1)
  1. See MembershipStatusType

MembershipSummaryTypeDef#

# 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)
  1. See MembershipStatusType
  2. See MemberAbilityType

ListProtectedQueriesInputRequestTypeDef#

# ListProtectedQueriesInputRequestTypeDef definition

class ListProtectedQueriesInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    status: NotRequired[ProtectedQueryStatusType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See ProtectedQueryStatusType

ProtectedQuerySummaryTypeDef#

# ProtectedQuerySummaryTypeDef definition

class ProtectedQuerySummaryTypeDef(TypedDict):
    id: str,
    membershipId: str,
    membershipArn: str,
    createTime: datetime,
    status: ProtectedQueryStatusType,  # (1)
  1. See ProtectedQueryStatusType

ListSchemasInputRequestTypeDef#

# ListSchemasInputRequestTypeDef definition

class ListSchemasInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    schemaType: NotRequired[SchemaTypeType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
  1. See SchemaTypeType

SchemaSummaryTypeDef#

# 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)
  1. See SchemaTypeType
  2. See AnalysisRuleTypeType
  3. See AnalysisMethodType

ListTagsForResourceInputRequestTypeDef#

# ListTagsForResourceInputRequestTypeDef definition

class ListTagsForResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,

ProtectedQueryS3OutputConfigurationTypeDef#

# ProtectedQueryS3OutputConfigurationTypeDef definition

class ProtectedQueryS3OutputConfigurationTypeDef(TypedDict):
    resultFormat: ResultFormatType,  # (1)
    bucket: str,
    keyPrefix: NotRequired[str],
  1. See ResultFormatType

ProtectedQueryErrorTypeDef#

# ProtectedQueryErrorTypeDef definition

class ProtectedQueryErrorTypeDef(TypedDict):
    message: str,
    code: str,

ProtectedQueryS3OutputTypeDef#

# ProtectedQueryS3OutputTypeDef definition

class ProtectedQueryS3OutputTypeDef(TypedDict):
    location: str,

ProtectedQuerySingleMemberOutputTypeDef#

# ProtectedQuerySingleMemberOutputTypeDef definition

class ProtectedQuerySingleMemberOutputTypeDef(TypedDict):
    accountId: str,

ProtectedQuerySQLParametersTypeDef#

# ProtectedQuerySQLParametersTypeDef definition

class ProtectedQuerySQLParametersTypeDef(TypedDict):
    queryString: NotRequired[str],
    analysisTemplateArn: NotRequired[str],
    parameters: NotRequired[Dict[str, str]],

ProtectedQueryStatisticsTypeDef#

# ProtectedQueryStatisticsTypeDef definition

class ProtectedQueryStatisticsTypeDef(TypedDict):
    totalDurationInMillis: NotRequired[int],

TagResourceInputRequestTypeDef#

# TagResourceInputRequestTypeDef definition

class TagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceInputRequestTypeDef#

# UntagResourceInputRequestTypeDef definition

class UntagResourceInputRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

UpdateAnalysisTemplateInputRequestTypeDef#

# UpdateAnalysisTemplateInputRequestTypeDef definition

class UpdateAnalysisTemplateInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    analysisTemplateIdentifier: str,
    description: NotRequired[str],

UpdateCollaborationInputRequestTypeDef#

# UpdateCollaborationInputRequestTypeDef definition

class UpdateCollaborationInputRequestTypeDef(TypedDict):
    collaborationIdentifier: str,
    name: NotRequired[str],
    description: NotRequired[str],

UpdateConfiguredTableAssociationInputRequestTypeDef#

# UpdateConfiguredTableAssociationInputRequestTypeDef definition

class UpdateConfiguredTableAssociationInputRequestTypeDef(TypedDict):
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,
    description: NotRequired[str],
    roleArn: NotRequired[str],

UpdateConfiguredTableInputRequestTypeDef#

# UpdateConfiguredTableInputRequestTypeDef definition

class UpdateConfiguredTableInputRequestTypeDef(TypedDict):
    configuredTableIdentifier: str,
    name: NotRequired[str],
    description: NotRequired[str],

UpdateProtectedQueryInputRequestTypeDef#

# UpdateProtectedQueryInputRequestTypeDef definition

class UpdateProtectedQueryInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    protectedQueryIdentifier: str,
    targetStatus: TargetProtectedQueryStatusType,  # (1)
  1. See TargetProtectedQueryStatusType

AnalysisRuleAggregationTypeDef#

# AnalysisRuleAggregationTypeDef definition

class AnalysisRuleAggregationTypeDef(TypedDict):
    aggregateColumns: Sequence[AggregateColumnTypeDef],  # (1)
    joinColumns: Sequence[str],
    dimensionColumns: Sequence[str],
    scalarFunctions: Sequence[ScalarFunctionsType],  # (4)
    outputConstraints: Sequence[AggregationConstraintTypeDef],  # (5)
    joinRequired: NotRequired[JoinRequiredOptionType],  # (2)
    allowedJoinOperators: NotRequired[Sequence[JoinOperatorType]],  # (3)
  1. See AggregateColumnTypeDef
  2. See JoinRequiredOptionType
  3. See JoinOperatorType
  4. See ScalarFunctionsType
  5. See AggregationConstraintTypeDef

AnalysisTemplateTypeDef#

# AnalysisTemplateTypeDef definition

class AnalysisTemplateTypeDef(TypedDict):
    id: str,
    arn: str,
    collaborationId: str,
    collaborationArn: str,
    membershipId: str,
    membershipArn: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    schema: AnalysisSchemaTypeDef,  # (1)
    format: AnalysisFormatType,  # (2)
    source: AnalysisSourceTypeDef,  # (3)
    description: NotRequired[str],
    analysisParameters: NotRequired[List[AnalysisParameterTypeDef]],  # (4)
  1. See AnalysisSchemaTypeDef
  2. See AnalysisFormatType
  3. See AnalysisSourceTypeDef
  4. See AnalysisParameterTypeDef

CollaborationAnalysisTemplateTypeDef#

# CollaborationAnalysisTemplateTypeDef definition

class CollaborationAnalysisTemplateTypeDef(TypedDict):
    id: str,
    arn: str,
    collaborationId: str,
    collaborationArn: str,
    creatorAccountId: str,
    name: str,
    createTime: datetime,
    updateTime: datetime,
    schema: AnalysisSchemaTypeDef,  # (1)
    format: AnalysisFormatType,  # (2)
    source: AnalysisSourceTypeDef,  # (3)
    description: NotRequired[str],
    analysisParameters: NotRequired[List[AnalysisParameterTypeDef]],  # (4)
  1. See AnalysisSchemaTypeDef
  2. See AnalysisFormatType
  3. See AnalysisSourceTypeDef
  4. See AnalysisParameterTypeDef

CreateAnalysisTemplateInputRequestTypeDef#

# CreateAnalysisTemplateInputRequestTypeDef definition

class CreateAnalysisTemplateInputRequestTypeDef(TypedDict):
    membershipIdentifier: str,
    name: str,
    format: AnalysisFormatType,  # (1)
    source: AnalysisSourceTypeDef,  # (2)
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    analysisParameters: NotRequired[Sequence[AnalysisParameterTypeDef]],  # (3)
  1. See AnalysisFormatType
  2. See AnalysisSourceTypeDef
  3. See AnalysisParameterTypeDef

ListAnalysisTemplatesOutputTypeDef#

# ListAnalysisTemplatesOutputTypeDef definition

class ListAnalysisTemplatesOutputTypeDef(TypedDict):
    nextToken: str,
    analysisTemplateSummaries: List[AnalysisTemplateSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceOutputTypeDef#

# ListTagsForResourceOutputTypeDef definition

class ListTagsForResourceOutputTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListCollaborationAnalysisTemplatesOutputTypeDef#

# ListCollaborationAnalysisTemplatesOutputTypeDef definition

class ListCollaborationAnalysisTemplatesOutputTypeDef(TypedDict):
    nextToken: str,
    collaborationAnalysisTemplateSummaries: List[CollaborationAnalysisTemplateSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationAnalysisTemplateSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListCollaborationsOutputTypeDef#

# ListCollaborationsOutputTypeDef definition

class ListCollaborationsOutputTypeDef(TypedDict):
    nextToken: str,
    collaborationList: List[CollaborationSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationSummaryTypeDef
  2. See ResponseMetadataTypeDef

CollaborationTypeDef#

# 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)
  1. See MemberStatusType
  2. See DataEncryptionMetadataTypeDef
  3. See CollaborationQueryLogStatusType

SchemaTypeDef#

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

ListConfiguredTableAssociationsOutputTypeDef#

# ListConfiguredTableAssociationsOutputTypeDef definition

class ListConfiguredTableAssociationsOutputTypeDef(TypedDict):
    configuredTableAssociationSummaries: List[ConfiguredTableAssociationSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateConfiguredTableAssociationOutputTypeDef#

# CreateConfiguredTableAssociationOutputTypeDef definition

class CreateConfiguredTableAssociationOutputTypeDef(TypedDict):
    configuredTableAssociation: ConfiguredTableAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationTypeDef
  2. See ResponseMetadataTypeDef

GetConfiguredTableAssociationOutputTypeDef#

# GetConfiguredTableAssociationOutputTypeDef definition

class GetConfiguredTableAssociationOutputTypeDef(TypedDict):
    configuredTableAssociation: ConfiguredTableAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationTypeDef
  2. See ResponseMetadataTypeDef

UpdateConfiguredTableAssociationOutputTypeDef#

# UpdateConfiguredTableAssociationOutputTypeDef definition

class UpdateConfiguredTableAssociationOutputTypeDef(TypedDict):
    configuredTableAssociation: ConfiguredTableAssociationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableAssociationTypeDef
  2. See ResponseMetadataTypeDef

ListConfiguredTablesOutputTypeDef#

# ListConfiguredTablesOutputTypeDef definition

class ListConfiguredTablesOutputTypeDef(TypedDict):
    configuredTableSummaries: List[ConfiguredTableSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ConfiguredTableSummaryTypeDef
  2. See ResponseMetadataTypeDef

CreateCollaborationInputRequestTypeDef#

# 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)
    tags: NotRequired[Mapping[str, str]],
  1. See MemberSpecificationTypeDef
  2. See MemberAbilityType
  3. See CollaborationQueryLogStatusType
  4. See DataEncryptionMetadataTypeDef

TableReferenceTypeDef#

# TableReferenceTypeDef definition

class TableReferenceTypeDef(TypedDict):
    glue: NotRequired[GlueTableReferenceTypeDef],  # (1)
  1. See GlueTableReferenceTypeDef

ListAnalysisTemplatesInputListAnalysisTemplatesPaginateTypeDef#

# ListAnalysisTemplatesInputListAnalysisTemplatesPaginateTypeDef definition

class ListAnalysisTemplatesInputListAnalysisTemplatesPaginateTypeDef(TypedDict):
    membershipIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListCollaborationAnalysisTemplatesInputListCollaborationAnalysisTemplatesPaginateTypeDef#

# ListCollaborationAnalysisTemplatesInputListCollaborationAnalysisTemplatesPaginateTypeDef definition

class ListCollaborationAnalysisTemplatesInputListCollaborationAnalysisTemplatesPaginateTypeDef(TypedDict):
    collaborationIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListCollaborationsInputListCollaborationsPaginateTypeDef#

# ListCollaborationsInputListCollaborationsPaginateTypeDef definition

class ListCollaborationsInputListCollaborationsPaginateTypeDef(TypedDict):
    memberStatus: NotRequired[FilterableMemberStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See FilterableMemberStatusType
  2. See PaginatorConfigTypeDef

ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef#

# ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef definition

class ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef(TypedDict):
    membershipIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef#

# ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef definition

class ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMembersInputListMembersPaginateTypeDef#

# ListMembersInputListMembersPaginateTypeDef definition

class ListMembersInputListMembersPaginateTypeDef(TypedDict):
    collaborationIdentifier: str,
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListMembershipsInputListMembershipsPaginateTypeDef#

# ListMembershipsInputListMembershipsPaginateTypeDef definition

class ListMembershipsInputListMembershipsPaginateTypeDef(TypedDict):
    status: NotRequired[MembershipStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See MembershipStatusType
  2. See PaginatorConfigTypeDef

ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef#

# ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef definition

class ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef(TypedDict):
    membershipIdentifier: str,
    status: NotRequired[ProtectedQueryStatusType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See ProtectedQueryStatusType
  2. See PaginatorConfigTypeDef

ListSchemasInputListSchemasPaginateTypeDef#

# ListSchemasInputListSchemasPaginateTypeDef definition

class ListSchemasInputListSchemasPaginateTypeDef(TypedDict):
    collaborationIdentifier: str,
    schemaType: NotRequired[SchemaTypeType],  # (1)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (2)
  1. See SchemaTypeType
  2. See PaginatorConfigTypeDef

ListMembersOutputTypeDef#

# ListMembersOutputTypeDef definition

class ListMembersOutputTypeDef(TypedDict):
    nextToken: str,
    memberSummaries: List[MemberSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MemberSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListMembershipsOutputTypeDef#

# ListMembershipsOutputTypeDef definition

class ListMembershipsOutputTypeDef(TypedDict):
    nextToken: str,
    membershipSummaries: List[MembershipSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MembershipSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListProtectedQueriesOutputTypeDef#

# ListProtectedQueriesOutputTypeDef definition

class ListProtectedQueriesOutputTypeDef(TypedDict):
    nextToken: str,
    protectedQueries: List[ProtectedQuerySummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See ProtectedQuerySummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSchemasOutputTypeDef#

# ListSchemasOutputTypeDef definition

class ListSchemasOutputTypeDef(TypedDict):
    schemaSummaries: List[SchemaSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaSummaryTypeDef
  2. See ResponseMetadataTypeDef

MembershipProtectedQueryOutputConfigurationTypeDef#

# MembershipProtectedQueryOutputConfigurationTypeDef definition

class MembershipProtectedQueryOutputConfigurationTypeDef(TypedDict):
    s3: NotRequired[ProtectedQueryS3OutputConfigurationTypeDef],  # (1)
  1. See ProtectedQueryS3OutputConfigurationTypeDef

ProtectedQueryOutputConfigurationTypeDef#

# ProtectedQueryOutputConfigurationTypeDef definition

class ProtectedQueryOutputConfigurationTypeDef(TypedDict):
    s3: NotRequired[ProtectedQueryS3OutputConfigurationTypeDef],  # (1)
  1. See ProtectedQueryS3OutputConfigurationTypeDef

ProtectedQueryOutputTypeDef#

# ProtectedQueryOutputTypeDef definition

class ProtectedQueryOutputTypeDef(TypedDict):
    s3: NotRequired[ProtectedQueryS3OutputTypeDef],  # (1)
    memberList: NotRequired[List[ProtectedQuerySingleMemberOutputTypeDef]],  # (2)
  1. See ProtectedQueryS3OutputTypeDef
  2. See ProtectedQuerySingleMemberOutputTypeDef

AnalysisRulePolicyV1TypeDef#

# AnalysisRulePolicyV1TypeDef definition

class AnalysisRulePolicyV1TypeDef(TypedDict):
    list: NotRequired[AnalysisRuleListTypeDef],  # (1)
    aggregation: NotRequired[AnalysisRuleAggregationTypeDef],  # (2)
    custom: NotRequired[AnalysisRuleCustomTypeDef],  # (3)
  1. See AnalysisRuleListTypeDef
  2. See AnalysisRuleAggregationTypeDef
  3. See AnalysisRuleCustomTypeDef

ConfiguredTableAnalysisRulePolicyV1TypeDef#

# ConfiguredTableAnalysisRulePolicyV1TypeDef definition

class ConfiguredTableAnalysisRulePolicyV1TypeDef(TypedDict):
    list: NotRequired[AnalysisRuleListTypeDef],  # (1)
    aggregation: NotRequired[AnalysisRuleAggregationTypeDef],  # (2)
    custom: NotRequired[AnalysisRuleCustomTypeDef],  # (3)
  1. See AnalysisRuleListTypeDef
  2. See AnalysisRuleAggregationTypeDef
  3. See AnalysisRuleCustomTypeDef

CreateAnalysisTemplateOutputTypeDef#

# CreateAnalysisTemplateOutputTypeDef definition

class CreateAnalysisTemplateOutputTypeDef(TypedDict):
    analysisTemplate: AnalysisTemplateTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisTemplateTypeDef
  2. See ResponseMetadataTypeDef

GetAnalysisTemplateOutputTypeDef#

# GetAnalysisTemplateOutputTypeDef definition

class GetAnalysisTemplateOutputTypeDef(TypedDict):
    analysisTemplate: AnalysisTemplateTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisTemplateTypeDef
  2. See ResponseMetadataTypeDef

UpdateAnalysisTemplateOutputTypeDef#

# UpdateAnalysisTemplateOutputTypeDef definition

class UpdateAnalysisTemplateOutputTypeDef(TypedDict):
    analysisTemplate: AnalysisTemplateTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AnalysisTemplateTypeDef
  2. See ResponseMetadataTypeDef

BatchGetCollaborationAnalysisTemplateOutputTypeDef#

# BatchGetCollaborationAnalysisTemplateOutputTypeDef definition

class BatchGetCollaborationAnalysisTemplateOutputTypeDef(TypedDict):
    collaborationAnalysisTemplates: List[CollaborationAnalysisTemplateTypeDef],  # (1)
    errors: List[BatchGetCollaborationAnalysisTemplateErrorTypeDef],  # (2)
    ResponseMetadata: ResponseMetadataTypeDef,  # (3)
  1. See CollaborationAnalysisTemplateTypeDef
  2. See BatchGetCollaborationAnalysisTemplateErrorTypeDef
  3. See ResponseMetadataTypeDef

GetCollaborationAnalysisTemplateOutputTypeDef#

# GetCollaborationAnalysisTemplateOutputTypeDef definition

class GetCollaborationAnalysisTemplateOutputTypeDef(TypedDict):
    collaborationAnalysisTemplate: CollaborationAnalysisTemplateTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationAnalysisTemplateTypeDef
  2. See ResponseMetadataTypeDef

CreateCollaborationOutputTypeDef#

# CreateCollaborationOutputTypeDef definition

class CreateCollaborationOutputTypeDef(TypedDict):
    collaboration: CollaborationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationTypeDef
  2. See ResponseMetadataTypeDef

GetCollaborationOutputTypeDef#

# GetCollaborationOutputTypeDef definition

class GetCollaborationOutputTypeDef(TypedDict):
    collaboration: CollaborationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationTypeDef
  2. See ResponseMetadataTypeDef

UpdateCollaborationOutputTypeDef#

# UpdateCollaborationOutputTypeDef definition

class UpdateCollaborationOutputTypeDef(TypedDict):
    collaboration: CollaborationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CollaborationTypeDef
  2. See ResponseMetadataTypeDef

BatchGetSchemaOutputTypeDef#

# BatchGetSchemaOutputTypeDef 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#

# GetSchemaOutputTypeDef definition

class GetSchemaOutputTypeDef(TypedDict):
    schema: SchemaTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SchemaTypeDef
  2. See ResponseMetadataTypeDef

ConfiguredTableTypeDef#

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

CreateConfiguredTableInputRequestTypeDef#

# CreateConfiguredTableInputRequestTypeDef definition

class CreateConfiguredTableInputRequestTypeDef(TypedDict):
    name: str,
    tableReference: TableReferenceTypeDef,  # (1)
    allowedColumns: Sequence[str],
    analysisMethod: AnalysisMethodType,  # (2)
    description: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
  1. See TableReferenceTypeDef
  2. See AnalysisMethodType

MembershipProtectedQueryResultConfigurationTypeDef#

# MembershipProtectedQueryResultConfigurationTypeDef definition

class MembershipProtectedQueryResultConfigurationTypeDef(TypedDict):
    outputConfiguration: MembershipProtectedQueryOutputConfigurationTypeDef,  # (1)
    roleArn: NotRequired[str],
  1. See MembershipProtectedQueryOutputConfigurationTypeDef

ProtectedQueryResultConfigurationTypeDef#

# ProtectedQueryResultConfigurationTypeDef definition

class ProtectedQueryResultConfigurationTypeDef(TypedDict):
    outputConfiguration: ProtectedQueryOutputConfigurationTypeDef,  # (1)
  1. See