CleanRoomsServiceClient

Index > CleanRoomsService > CleanRoomsServiceClient

Auto-generated documentation for CleanRoomsService type annotations stubs module types-aiobotocore-cleanrooms.

CleanRoomsServiceClient

Type annotations and code completion for session.create_client("cleanrooms") boto3 documentation

CleanRoomsServiceClient usage example

from aiobotocore.session import get_session
from types_aiobotocore_cleanrooms.client import CleanRoomsServiceClient

session = get_session()
async with session.create_client("cleanrooms") as client:
    client: CleanRoomsServiceClient

Exceptions

aiobotocore client exceptions are generated in runtime. This class provides code completion for session.create_client("cleanrooms").exceptions structure.

CleanRoomsServiceClient.exceptions usage example

async with session.create_client("cleanrooms") as client:
    try:
        do_something(client)
    except (
            client.AccessDeniedException,
        client.ClientError,
        client.ConflictException,
        client.InternalServerException,
        client.ResourceNotFoundException,
        client.ServiceQuotaExceededException,
        client.ThrottlingException,
        client.ValidationException,
    ) as e:
        print(e)

CleanRoomsServiceClient usage type checking example

from types_aiobotocore_cleanrooms.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

batch_get_collaboration_analysis_template

Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).

Type annotations and code completion for session.create_client("cleanrooms").batch_get_collaboration_analysis_template method. boto3 documentation

# batch_get_collaboration_analysis_template method definition

await def batch_get_collaboration_analysis_template(
    self,
    *,
    collaborationIdentifier: str,
    analysisTemplateArns: Sequence[str],
) -> BatchGetCollaborationAnalysisTemplateOutputTypeDef:  # (1)
    ...

1. See BatchGetCollaborationAnalysisTemplateOutputTypeDef

# batch_get_collaboration_analysis_template method usage example with argument unpacking

kwargs: BatchGetCollaborationAnalysisTemplateInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
    "analysisTemplateArns": ...,
}

parent.batch_get_collaboration_analysis_template(**kwargs)

1. See BatchGetCollaborationAnalysisTemplateInputRequestTypeDef

batch_get_schema

Retrieves multiple schemas by their identifiers.

Type annotations and code completion for session.create_client("cleanrooms").batch_get_schema method. boto3 documentation

# batch_get_schema method definition

await def batch_get_schema(
    self,
    *,
    collaborationIdentifier: str,
    names: Sequence[str],
) -> BatchGetSchemaOutputTypeDef:  # (1)
    ...

1. See BatchGetSchemaOutputTypeDef

# batch_get_schema method usage example with argument unpacking

kwargs: BatchGetSchemaInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
    "names": ...,
}

parent.batch_get_schema(**kwargs)

1. See BatchGetSchemaInputRequestTypeDef

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for session.create_client("cleanrooms").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for session.create_client("cleanrooms").close method. boto3 documentation

# close method definition

await def close(
    self,
) -> None:
    ...

create_analysis_template

Creates a new analysis template.

Type annotations and code completion for session.create_client("cleanrooms").create_analysis_template method. boto3 documentation

# create_analysis_template method definition

await def create_analysis_template(
    self,
    *,
    membershipIdentifier: str,
    name: str,
    format: AnalysisFormatType,  # (1)
    source: AnalysisSourceTypeDef,  # (2)
    description: str = ...,
    tags: Mapping[str, str] = ...,
    analysisParameters: Sequence[AnalysisParameterTypeDef] = ...,  # (3)
) -> CreateAnalysisTemplateOutputTypeDef:  # (4)
    ...

1. See AnalysisFormatType
2. See AnalysisSourceTypeDef
3. See AnalysisParameterTypeDef
4. See CreateAnalysisTemplateOutputTypeDef

# create_analysis_template method usage example with argument unpacking

kwargs: CreateAnalysisTemplateInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
    "name": ...,
    "format": ...,
    "source": ...,
}

parent.create_analysis_template(**kwargs)

1. See CreateAnalysisTemplateInputRequestTypeDef

create_collaboration

Creates a new collaboration.

Type annotations and code completion for session.create_client("cleanrooms").create_collaboration method. boto3 documentation

# create_collaboration method definition

await def create_collaboration(
    self,
    *,
    members: Sequence[MemberSpecificationTypeDef],  # (1)
    name: str,
    description: str,
    creatorMemberAbilities: Sequence[MemberAbilityType],  # (2)
    creatorDisplayName: str,
    queryLogStatus: CollaborationQueryLogStatusType,  # (3)
    dataEncryptionMetadata: DataEncryptionMetadataTypeDef = ...,  # (4)
    tags: Mapping[str, str] = ...,
) -> CreateCollaborationOutputTypeDef:  # (5)
    ...

1. See MemberSpecificationTypeDef
2. See MemberAbilityType
3. See CollaborationQueryLogStatusType
4. See DataEncryptionMetadataTypeDef
5. See CreateCollaborationOutputTypeDef

# create_collaboration method usage example with argument unpacking

kwargs: CreateCollaborationInputRequestTypeDef = {  # (1)
    "members": ...,
    "name": ...,
    "description": ...,
    "creatorMemberAbilities": ...,
    "creatorDisplayName": ...,
    "queryLogStatus": ...,
}

parent.create_collaboration(**kwargs)

1. See CreateCollaborationInputRequestTypeDef

create_configured_table

Creates a new configured table resource.

Type annotations and code completion for session.create_client("cleanrooms").create_configured_table method. boto3 documentation

# create_configured_table method definition

await def create_configured_table(
    self,
    *,
    name: str,
    tableReference: TableReferenceTypeDef,  # (1)
    allowedColumns: Sequence[str],
    analysisMethod: AnalysisMethodType,  # (2)
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateConfiguredTableOutputTypeDef:  # (3)
    ...

1. See TableReferenceTypeDef
2. See AnalysisMethodType
3. See CreateConfiguredTableOutputTypeDef

# create_configured_table method usage example with argument unpacking

kwargs: CreateConfiguredTableInputRequestTypeDef = {  # (1)
    "name": ...,
    "tableReference": ...,
    "allowedColumns": ...,
    "analysisMethod": ...,
}

parent.create_configured_table(**kwargs)

1. See CreateConfiguredTableInputRequestTypeDef

create_configured_table_analysis_rule

Creates a new analysis rule for a configured table.

Type annotations and code completion for session.create_client("cleanrooms").create_configured_table_analysis_rule method. boto3 documentation

# create_configured_table_analysis_rule method definition

await def create_configured_table_analysis_rule(
    self,
    *,
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
    analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef,  # (2)
) -> CreateConfiguredTableAnalysisRuleOutputTypeDef:  # (3)
    ...

1. See ConfiguredTableAnalysisRuleTypeType
2. See ConfiguredTableAnalysisRulePolicyTypeDef
3. See CreateConfiguredTableAnalysisRuleOutputTypeDef

# create_configured_table_analysis_rule method usage example with argument unpacking

kwargs: CreateConfiguredTableAnalysisRuleInputRequestTypeDef = {  # (1)
    "configuredTableIdentifier": ...,
    "analysisRuleType": ...,
    "analysisRulePolicy": ...,
}

parent.create_configured_table_analysis_rule(**kwargs)

1. See CreateConfiguredTableAnalysisRuleInputRequestTypeDef

create_configured_table_association

Creates a configured table association.

Type annotations and code completion for session.create_client("cleanrooms").create_configured_table_association method. boto3 documentation

# create_configured_table_association method definition

await def create_configured_table_association(
    self,
    *,
    name: str,
    membershipIdentifier: str,
    configuredTableIdentifier: str,
    roleArn: str,
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateConfiguredTableAssociationOutputTypeDef:  # (1)
    ...

1. See CreateConfiguredTableAssociationOutputTypeDef

# create_configured_table_association method usage example with argument unpacking

kwargs: CreateConfiguredTableAssociationInputRequestTypeDef = {  # (1)
    "name": ...,
    "membershipIdentifier": ...,
    "configuredTableIdentifier": ...,
    "roleArn": ...,
}

parent.create_configured_table_association(**kwargs)

1. See CreateConfiguredTableAssociationInputRequestTypeDef

create_membership

Creates a membership for a specific collaboration identifier and joins the collaboration.

Type annotations and code completion for session.create_client("cleanrooms").create_membership method. boto3 documentation

# create_membership method definition

await def create_membership(
    self,
    *,
    collaborationIdentifier: str,
    queryLogStatus: MembershipQueryLogStatusType,  # (1)
    tags: Mapping[str, str] = ...,
) -> CreateMembershipOutputTypeDef:  # (2)
    ...

1. See MembershipQueryLogStatusType
2. See CreateMembershipOutputTypeDef

# create_membership method usage example with argument unpacking

kwargs: CreateMembershipInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
    "queryLogStatus": ...,
}

parent.create_membership(**kwargs)

1. See CreateMembershipInputRequestTypeDef

delete_analysis_template

Deletes an analysis template.

Type annotations and code completion for session.create_client("cleanrooms").delete_analysis_template method. boto3 documentation

# delete_analysis_template method definition

await def delete_analysis_template(
    self,
    *,
    membershipIdentifier: str,
    analysisTemplateIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_analysis_template method usage example with argument unpacking

kwargs: DeleteAnalysisTemplateInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
    "analysisTemplateIdentifier": ...,
}

parent.delete_analysis_template(**kwargs)

1. See DeleteAnalysisTemplateInputRequestTypeDef

delete_collaboration

Deletes a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").delete_collaboration method. boto3 documentation

# delete_collaboration method definition

await def delete_collaboration(
    self,
    *,
    collaborationIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_collaboration method usage example with argument unpacking

kwargs: DeleteCollaborationInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
}

parent.delete_collaboration(**kwargs)

1. See DeleteCollaborationInputRequestTypeDef

delete_configured_table

Deletes a configured table.

Type annotations and code completion for session.create_client("cleanrooms").delete_configured_table method. boto3 documentation

# delete_configured_table method definition

await def delete_configured_table(
    self,
    *,
    configuredTableIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_configured_table method usage example with argument unpacking

kwargs: DeleteConfiguredTableInputRequestTypeDef = {  # (1)
    "configuredTableIdentifier": ...,
}

parent.delete_configured_table(**kwargs)

1. See DeleteConfiguredTableInputRequestTypeDef

delete_configured_table_analysis_rule

Deletes a configured table analysis rule.

Type annotations and code completion for session.create_client("cleanrooms").delete_configured_table_analysis_rule method. boto3 documentation

# delete_configured_table_analysis_rule method definition

await def delete_configured_table_analysis_rule(
    self,
    *,
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
) -> Dict[str, Any]:
    ...

1. See ConfiguredTableAnalysisRuleTypeType

# delete_configured_table_analysis_rule method usage example with argument unpacking

kwargs: DeleteConfiguredTableAnalysisRuleInputRequestTypeDef = {  # (1)
    "configuredTableIdentifier": ...,
    "analysisRuleType": ...,
}

parent.delete_configured_table_analysis_rule(**kwargs)

1. See DeleteConfiguredTableAnalysisRuleInputRequestTypeDef

delete_configured_table_association

Deletes a configured table association.

Type annotations and code completion for session.create_client("cleanrooms").delete_configured_table_association method. boto3 documentation

# delete_configured_table_association method definition

await def delete_configured_table_association(
    self,
    *,
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_configured_table_association method usage example with argument unpacking

kwargs: DeleteConfiguredTableAssociationInputRequestTypeDef = {  # (1)
    "configuredTableAssociationIdentifier": ...,
    "membershipIdentifier": ...,
}

parent.delete_configured_table_association(**kwargs)

1. See DeleteConfiguredTableAssociationInputRequestTypeDef

delete_member

Removes the specified member from a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").delete_member method. boto3 documentation

# delete_member method definition

await def delete_member(
    self,
    *,
    collaborationIdentifier: str,
    accountId: str,
) -> Dict[str, Any]:
    ...

# delete_member method usage example with argument unpacking

kwargs: DeleteMemberInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
    "accountId": ...,
}

parent.delete_member(**kwargs)

1. See DeleteMemberInputRequestTypeDef

delete_membership

Deletes a specified membership.

Type annotations and code completion for session.create_client("cleanrooms").delete_membership method. boto3 documentation

# delete_membership method definition

await def delete_membership(
    self,
    *,
    membershipIdentifier: str,
) -> Dict[str, Any]:
    ...

# delete_membership method usage example with argument unpacking

kwargs: DeleteMembershipInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
}

parent.delete_membership(**kwargs)

1. See DeleteMembershipInputRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for session.create_client("cleanrooms").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

await def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

get_analysis_template

Retrieves an analysis template.

Type annotations and code completion for session.create_client("cleanrooms").get_analysis_template method. boto3 documentation

# get_analysis_template method definition

await def get_analysis_template(
    self,
    *,
    membershipIdentifier: str,
    analysisTemplateIdentifier: str,
) -> GetAnalysisTemplateOutputTypeDef:  # (1)
    ...

1. See GetAnalysisTemplateOutputTypeDef

# get_analysis_template method usage example with argument unpacking

kwargs: GetAnalysisTemplateInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
    "analysisTemplateIdentifier": ...,
}

parent.get_analysis_template(**kwargs)

1. See GetAnalysisTemplateInputRequestTypeDef

get_collaboration

Returns metadata about a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").get_collaboration method. boto3 documentation

# get_collaboration method definition

await def get_collaboration(
    self,
    *,
    collaborationIdentifier: str,
) -> GetCollaborationOutputTypeDef:  # (1)
    ...

1. See GetCollaborationOutputTypeDef

# get_collaboration method usage example with argument unpacking

kwargs: GetCollaborationInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
}

parent.get_collaboration(**kwargs)

1. See GetCollaborationInputRequestTypeDef

get_collaboration_analysis_template

Retrieves an analysis template within a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").get_collaboration_analysis_template method. boto3 documentation

# get_collaboration_analysis_template method definition

await def get_collaboration_analysis_template(
    self,
    *,
    collaborationIdentifier: str,
    analysisTemplateArn: str,
) -> GetCollaborationAnalysisTemplateOutputTypeDef:  # (1)
    ...

1. See GetCollaborationAnalysisTemplateOutputTypeDef

# get_collaboration_analysis_template method usage example with argument unpacking

kwargs: GetCollaborationAnalysisTemplateInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
    "analysisTemplateArn": ...,
}

parent.get_collaboration_analysis_template(**kwargs)

1. See GetCollaborationAnalysisTemplateInputRequestTypeDef

get_configured_table

Retrieves a configured table.

Type annotations and code completion for session.create_client("cleanrooms").get_configured_table method. boto3 documentation

# get_configured_table method definition

await def get_configured_table(
    self,
    *,
    configuredTableIdentifier: str,
) -> GetConfiguredTableOutputTypeDef:  # (1)
    ...

1. See GetConfiguredTableOutputTypeDef

# get_configured_table method usage example with argument unpacking

kwargs: GetConfiguredTableInputRequestTypeDef = {  # (1)
    "configuredTableIdentifier": ...,
}

parent.get_configured_table(**kwargs)

1. See GetConfiguredTableInputRequestTypeDef

get_configured_table_analysis_rule

Retrieves a configured table analysis rule.

Type annotations and code completion for session.create_client("cleanrooms").get_configured_table_analysis_rule method. boto3 documentation

# get_configured_table_analysis_rule method definition

await def get_configured_table_analysis_rule(
    self,
    *,
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
) -> GetConfiguredTableAnalysisRuleOutputTypeDef:  # (2)
    ...

1. See ConfiguredTableAnalysisRuleTypeType
2. See GetConfiguredTableAnalysisRuleOutputTypeDef

# get_configured_table_analysis_rule method usage example with argument unpacking

kwargs: GetConfiguredTableAnalysisRuleInputRequestTypeDef = {  # (1)
    "configuredTableIdentifier": ...,
    "analysisRuleType": ...,
}

parent.get_configured_table_analysis_rule(**kwargs)

1. See GetConfiguredTableAnalysisRuleInputRequestTypeDef

get_configured_table_association

Retrieves a configured table association.

Type annotations and code completion for session.create_client("cleanrooms").get_configured_table_association method. boto3 documentation

# get_configured_table_association method definition

await def get_configured_table_association(
    self,
    *,
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,
) -> GetConfiguredTableAssociationOutputTypeDef:  # (1)
    ...

1. See GetConfiguredTableAssociationOutputTypeDef

# get_configured_table_association method usage example with argument unpacking

kwargs: GetConfiguredTableAssociationInputRequestTypeDef = {  # (1)
    "configuredTableAssociationIdentifier": ...,
    "membershipIdentifier": ...,
}

parent.get_configured_table_association(**kwargs)

1. See GetConfiguredTableAssociationInputRequestTypeDef

get_membership

Retrieves a specified membership for an identifier.

Type annotations and code completion for session.create_client("cleanrooms").get_membership method. boto3 documentation

# get_membership method definition

await def get_membership(
    self,
    *,
    membershipIdentifier: str,
) -> GetMembershipOutputTypeDef:  # (1)
    ...

1. See GetMembershipOutputTypeDef

# get_membership method usage example with argument unpacking

kwargs: GetMembershipInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
}

parent.get_membership(**kwargs)

1. See GetMembershipInputRequestTypeDef

get_protected_query

Returns query processing metadata.

Type annotations and code completion for session.create_client("cleanrooms").get_protected_query method. boto3 documentation

# get_protected_query method definition

await def get_protected_query(
    self,
    *,
    membershipIdentifier: str,
    protectedQueryIdentifier: str,
) -> GetProtectedQueryOutputTypeDef:  # (1)
    ...

1. See GetProtectedQueryOutputTypeDef

# get_protected_query method usage example with argument unpacking

kwargs: GetProtectedQueryInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
    "protectedQueryIdentifier": ...,
}

parent.get_protected_query(**kwargs)

1. See GetProtectedQueryInputRequestTypeDef

get_schema

Retrieves the schema for a relation within a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").get_schema method. boto3 documentation

# get_schema method definition

await def get_schema(
    self,
    *,
    collaborationIdentifier: str,
    name: str,
) -> GetSchemaOutputTypeDef:  # (1)
    ...

1. See GetSchemaOutputTypeDef

# get_schema method usage example with argument unpacking

kwargs: GetSchemaInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
    "name": ...,
}

parent.get_schema(**kwargs)

1. See GetSchemaInputRequestTypeDef

get_schema_analysis_rule

Retrieves a schema analysis rule.

Type annotations and code completion for session.create_client("cleanrooms").get_schema_analysis_rule method. boto3 documentation

# get_schema_analysis_rule method definition

await def get_schema_analysis_rule(
    self,
    *,
    collaborationIdentifier: str,
    name: str,
    type: AnalysisRuleTypeType,  # (1)
) -> GetSchemaAnalysisRuleOutputTypeDef:  # (2)
    ...

1. See AnalysisRuleTypeType
2. See GetSchemaAnalysisRuleOutputTypeDef

# get_schema_analysis_rule method usage example with argument unpacking

kwargs: GetSchemaAnalysisRuleInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
    "name": ...,
    "type": ...,
}

parent.get_schema_analysis_rule(**kwargs)

1. See GetSchemaAnalysisRuleInputRequestTypeDef

list_analysis_templates

Lists analysis templates that the caller owns.

Type annotations and code completion for session.create_client("cleanrooms").list_analysis_templates method. boto3 documentation

# list_analysis_templates method definition

await def list_analysis_templates(
    self,
    *,
    membershipIdentifier: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListAnalysisTemplatesOutputTypeDef:  # (1)
    ...

1. See ListAnalysisTemplatesOutputTypeDef

# list_analysis_templates method usage example with argument unpacking

kwargs: ListAnalysisTemplatesInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
}

parent.list_analysis_templates(**kwargs)

1. See ListAnalysisTemplatesInputRequestTypeDef

list_collaboration_analysis_templates

Lists analysis templates within a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").list_collaboration_analysis_templates method. boto3 documentation

# list_collaboration_analysis_templates method definition

await def list_collaboration_analysis_templates(
    self,
    *,
    collaborationIdentifier: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListCollaborationAnalysisTemplatesOutputTypeDef:  # (1)
    ...

1. See ListCollaborationAnalysisTemplatesOutputTypeDef

# list_collaboration_analysis_templates method usage example with argument unpacking

kwargs: ListCollaborationAnalysisTemplatesInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
}

parent.list_collaboration_analysis_templates(**kwargs)

1. See ListCollaborationAnalysisTemplatesInputRequestTypeDef

list_collaborations

Lists collaborations the caller owns, is active in, or has been invited to.

Type annotations and code completion for session.create_client("cleanrooms").list_collaborations method. boto3 documentation

# list_collaborations method definition

await def list_collaborations(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    memberStatus: FilterableMemberStatusType = ...,  # (1)
) -> ListCollaborationsOutputTypeDef:  # (2)
    ...

1. See FilterableMemberStatusType
2. See ListCollaborationsOutputTypeDef

# list_collaborations method usage example with argument unpacking

kwargs: ListCollaborationsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_collaborations(**kwargs)

1. See ListCollaborationsInputRequestTypeDef

list_configured_table_associations

Lists configured table associations for a membership.

Type annotations and code completion for session.create_client("cleanrooms").list_configured_table_associations method. boto3 documentation

# list_configured_table_associations method definition

await def list_configured_table_associations(
    self,
    *,
    membershipIdentifier: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListConfiguredTableAssociationsOutputTypeDef:  # (1)
    ...

1. See ListConfiguredTableAssociationsOutputTypeDef

# list_configured_table_associations method usage example with argument unpacking

kwargs: ListConfiguredTableAssociationsInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
}

parent.list_configured_table_associations(**kwargs)

1. See ListConfiguredTableAssociationsInputRequestTypeDef

list_configured_tables

Lists configured tables.

Type annotations and code completion for session.create_client("cleanrooms").list_configured_tables method. boto3 documentation

# list_configured_tables method definition

await def list_configured_tables(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListConfiguredTablesOutputTypeDef:  # (1)
    ...

1. See ListConfiguredTablesOutputTypeDef

# list_configured_tables method usage example with argument unpacking

kwargs: ListConfiguredTablesInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_configured_tables(**kwargs)

1. See ListConfiguredTablesInputRequestTypeDef

list_members

Lists all members within a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").list_members method. boto3 documentation

# list_members method definition

await def list_members(
    self,
    *,
    collaborationIdentifier: str,
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListMembersOutputTypeDef:  # (1)
    ...

1. See ListMembersOutputTypeDef

# list_members method usage example with argument unpacking

kwargs: ListMembersInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
}

parent.list_members(**kwargs)

1. See ListMembersInputRequestTypeDef

list_memberships

Lists all memberships resources within the caller's account.

Type annotations and code completion for session.create_client("cleanrooms").list_memberships method. boto3 documentation

# list_memberships method definition

await def list_memberships(
    self,
    *,
    nextToken: str = ...,
    maxResults: int = ...,
    status: MembershipStatusType = ...,  # (1)
) -> ListMembershipsOutputTypeDef:  # (2)
    ...

1. See MembershipStatusType
2. See ListMembershipsOutputTypeDef

# list_memberships method usage example with argument unpacking

kwargs: ListMembershipsInputRequestTypeDef = {  # (1)
    "nextToken": ...,
}

parent.list_memberships(**kwargs)

1. See ListMembershipsInputRequestTypeDef

list_protected_queries

Lists protected queries, sorted by the most recent query.

Type annotations and code completion for session.create_client("cleanrooms").list_protected_queries method. boto3 documentation

# list_protected_queries method definition

await def list_protected_queries(
    self,
    *,
    membershipIdentifier: str,
    status: ProtectedQueryStatusType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListProtectedQueriesOutputTypeDef:  # (2)
    ...

1. See ProtectedQueryStatusType
2. See ListProtectedQueriesOutputTypeDef

# list_protected_queries method usage example with argument unpacking

kwargs: ListProtectedQueriesInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
}

parent.list_protected_queries(**kwargs)

1. See ListProtectedQueriesInputRequestTypeDef

list_schemas

Lists the schemas for relations within a collaboration.

Type annotations and code completion for session.create_client("cleanrooms").list_schemas method. boto3 documentation

# list_schemas method definition

await def list_schemas(
    self,
    *,
    collaborationIdentifier: str,
    schemaType: SchemaTypeType = ...,  # (1)
    nextToken: str = ...,
    maxResults: int = ...,
) -> ListSchemasOutputTypeDef:  # (2)
    ...

1. See SchemaTypeType
2. See ListSchemasOutputTypeDef

# list_schemas method usage example with argument unpacking

kwargs: ListSchemasInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
}

parent.list_schemas(**kwargs)

1. See ListSchemasInputRequestTypeDef

list_tags_for_resource

Lists all of the tags that have been added to a resource.

Type annotations and code completion for session.create_client("cleanrooms").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

await def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceOutputTypeDef:  # (1)
    ...

1. See ListTagsForResourceOutputTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceInputRequestTypeDef

start_protected_query

Creates a protected query that is started by Clean Rooms .

Type annotations and code completion for session.create_client("cleanrooms").start_protected_query method. boto3 documentation

# start_protected_query method definition

await def start_protected_query(
    self,
    *,
    type: ProtectedQueryTypeType,  # (1)
    membershipIdentifier: str,
    sqlParameters: ProtectedQuerySQLParametersTypeDef,  # (2)
    resultConfiguration: ProtectedQueryResultConfigurationTypeDef,  # (3)
) -> StartProtectedQueryOutputTypeDef:  # (4)
    ...

1. See ProtectedQueryTypeType
2. See ProtectedQuerySQLParametersTypeDef
3. See ProtectedQueryResultConfigurationTypeDef
4. See StartProtectedQueryOutputTypeDef

# start_protected_query method usage example with argument unpacking

kwargs: StartProtectedQueryInputRequestTypeDef = {  # (1)
    "type": ...,
    "membershipIdentifier": ...,
    "sqlParameters": ...,
    "resultConfiguration": ...,
}

parent.start_protected_query(**kwargs)

1. See StartProtectedQueryInputRequestTypeDef

tag_resource

Tags a resource.

Type annotations and code completion for session.create_client("cleanrooms").tag_resource method. boto3 documentation

# tag_resource method definition

await def tag_resource(
    self,
    *,
    resourceArn: str,
    tags: Mapping[str, str],
) -> Dict[str, Any]:
    ...

# tag_resource method usage example with argument unpacking

kwargs: TagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceInputRequestTypeDef

untag_resource

Removes a tag or list of tags from a resource.

Type annotations and code completion for session.create_client("cleanrooms").untag_resource method. boto3 documentation

# untag_resource method definition

await def untag_resource(
    self,
    *,
    resourceArn: str,
    tagKeys: Sequence[str],
) -> Dict[str, Any]:
    ...

# untag_resource method usage example with argument unpacking

kwargs: UntagResourceInputRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceInputRequestTypeDef

update_analysis_template

Updates the analysis template metadata.

Type annotations and code completion for session.create_client("cleanrooms").update_analysis_template method. boto3 documentation

# update_analysis_template method definition

await def update_analysis_template(
    self,
    *,
    membershipIdentifier: str,
    analysisTemplateIdentifier: str,
    description: str = ...,
) -> UpdateAnalysisTemplateOutputTypeDef:  # (1)
    ...

1. See UpdateAnalysisTemplateOutputTypeDef

# update_analysis_template method usage example with argument unpacking

kwargs: UpdateAnalysisTemplateInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
    "analysisTemplateIdentifier": ...,
}

parent.update_analysis_template(**kwargs)

1. See UpdateAnalysisTemplateInputRequestTypeDef

update_collaboration

Updates collaboration metadata and can only be called by the collaboration owner.

Type annotations and code completion for session.create_client("cleanrooms").update_collaboration method. boto3 documentation

# update_collaboration method definition

await def update_collaboration(
    self,
    *,
    collaborationIdentifier: str,
    name: str = ...,
    description: str = ...,
) -> UpdateCollaborationOutputTypeDef:  # (1)
    ...

1. See UpdateCollaborationOutputTypeDef

# update_collaboration method usage example with argument unpacking

kwargs: UpdateCollaborationInputRequestTypeDef = {  # (1)
    "collaborationIdentifier": ...,
}

parent.update_collaboration(**kwargs)

1. See UpdateCollaborationInputRequestTypeDef

update_configured_table

Updates a configured table.

Type annotations and code completion for session.create_client("cleanrooms").update_configured_table method. boto3 documentation

# update_configured_table method definition

await def update_configured_table(
    self,
    *,
    configuredTableIdentifier: str,
    name: str = ...,
    description: str = ...,
) -> UpdateConfiguredTableOutputTypeDef:  # (1)
    ...

1. See UpdateConfiguredTableOutputTypeDef

# update_configured_table method usage example with argument unpacking

kwargs: UpdateConfiguredTableInputRequestTypeDef = {  # (1)
    "configuredTableIdentifier": ...,
}

parent.update_configured_table(**kwargs)

1. See UpdateConfiguredTableInputRequestTypeDef

update_configured_table_analysis_rule

Updates a configured table analysis rule.

Type annotations and code completion for session.create_client("cleanrooms").update_configured_table_analysis_rule method. boto3 documentation

# update_configured_table_analysis_rule method definition

await def update_configured_table_analysis_rule(
    self,
    *,
    configuredTableIdentifier: str,
    analysisRuleType: ConfiguredTableAnalysisRuleTypeType,  # (1)
    analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef,  # (2)
) -> UpdateConfiguredTableAnalysisRuleOutputTypeDef:  # (3)
    ...

1. See ConfiguredTableAnalysisRuleTypeType
2. See ConfiguredTableAnalysisRulePolicyTypeDef
3. See UpdateConfiguredTableAnalysisRuleOutputTypeDef

# update_configured_table_analysis_rule method usage example with argument unpacking

kwargs: UpdateConfiguredTableAnalysisRuleInputRequestTypeDef = {  # (1)
    "configuredTableIdentifier": ...,
    "analysisRuleType": ...,
    "analysisRulePolicy": ...,
}

parent.update_configured_table_analysis_rule(**kwargs)

1. See UpdateConfiguredTableAnalysisRuleInputRequestTypeDef

update_configured_table_association

Updates a configured table association.

Type annotations and code completion for session.create_client("cleanrooms").update_configured_table_association method. boto3 documentation

# update_configured_table_association method definition

await def update_configured_table_association(
    self,
    *,
    configuredTableAssociationIdentifier: str,
    membershipIdentifier: str,
    description: str = ...,
    roleArn: str = ...,
) -> UpdateConfiguredTableAssociationOutputTypeDef:  # (1)
    ...

1. See UpdateConfiguredTableAssociationOutputTypeDef

# update_configured_table_association method usage example with argument unpacking

kwargs: UpdateConfiguredTableAssociationInputRequestTypeDef = {  # (1)
    "configuredTableAssociationIdentifier": ...,
    "membershipIdentifier": ...,
}

parent.update_configured_table_association(**kwargs)

1. See UpdateConfiguredTableAssociationInputRequestTypeDef

update_membership

Updates a membership.

Type annotations and code completion for session.create_client("cleanrooms").update_membership method. boto3 documentation

# update_membership method definition

await def update_membership(
    self,
    *,
    membershipIdentifier: str,
    queryLogStatus: MembershipQueryLogStatusType = ...,  # (1)
) -> UpdateMembershipOutputTypeDef:  # (2)
    ...

1. See MembershipQueryLogStatusType
2. See UpdateMembershipOutputTypeDef

# update_membership method usage example with argument unpacking

kwargs: UpdateMembershipInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
}

parent.update_membership(**kwargs)

1. See UpdateMembershipInputRequestTypeDef

update_protected_query

Updates the processing of a currently running query.

Type annotations and code completion for session.create_client("cleanrooms").update_protected_query method. boto3 documentation

# update_protected_query method definition

await def update_protected_query(
    self,
    *,
    membershipIdentifier: str,
    protectedQueryIdentifier: str,
    targetStatus: TargetProtectedQueryStatusType,  # (1)
) -> UpdateProtectedQueryOutputTypeDef:  # (2)
    ...

1. See TargetProtectedQueryStatusType
2. See UpdateProtectedQueryOutputTypeDef

# update_protected_query method usage example with argument unpacking

kwargs: UpdateProtectedQueryInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
    "protectedQueryIdentifier": ...,
    "targetStatus": ...,
}

parent.update_protected_query(**kwargs)

1. See UpdateProtectedQueryInputRequestTypeDef

__aenter__

Type annotations and code completion for session.create_client("cleanrooms").__aenter__ method. boto3 documentation

# __aenter__ method definition

await def __aenter__(
    self,
) -> CleanRoomsServiceClient:
    ...

__aexit__

Type annotations and code completion for session.create_client("cleanrooms").__aexit__ method. boto3 documentation

# __aexit__ method definition

await def __aexit__(
    self,
    exc_type: Any,
    exc_val: Any,
    exc_tb: Any,
) -> Any:
    ...

get_paginator

Type annotations and code completion for session.create_client("cleanrooms").get_paginator method with overloads.

• client.get_paginator("list_analysis_templates") -> ListAnalysisTemplatesPaginator
• client.get_paginator("list_collaboration_analysis_templates") -> ListCollaborationAnalysisTemplatesPaginator
• client.get_paginator("list_collaborations") -> ListCollaborationsPaginator
• client.get_paginator("list_configured_table_associations") -> ListConfiguredTableAssociationsPaginator
• client.get_paginator("list_configured_tables") -> ListConfiguredTablesPaginator
• client.get_paginator("list_members") -> ListMembersPaginator
• client.get_paginator("list_memberships") -> ListMembershipsPaginator
• client.get_paginator("list_protected_queries") -> ListProtectedQueriesPaginator
• client.get_paginator("list_schemas") -> ListSchemasPaginator