Skip to content

CleanRoomsServiceClient#

Index > CleanRoomsService > CleanRoomsServiceClient

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

CleanRoomsServiceClient#

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

# CleanRoomsServiceClient usage example

from boto3.session import Session
from mypy_boto3_cleanrooms.client import CleanRoomsServiceClient

def get_cleanrooms_client() -> CleanRoomsServiceClient:
    return Session().client("cleanrooms")

Exceptions#

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

# Exceptions.exceptions usage example

client = boto3.client("cleanrooms")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.InternalServerException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ThrottlingException,
    client.exceptions.ValidationException,
) as e:
    print(e)
# Exceptions.exceptions type checking example

from mypy_boto3_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 boto3.client("cleanrooms").batch_get_collaboration_analysis_template method. boto3 documentation

# batch_get_collaboration_analysis_template method definition

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 boto3.client("cleanrooms").batch_get_schema method. boto3 documentation

# batch_get_schema method definition

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

batch_get_schema_analysis_rule#

Retrieves multiple analysis rule schemas.

Type annotations and code completion for boto3.client("cleanrooms").batch_get_schema_analysis_rule method. boto3 documentation

# batch_get_schema_analysis_rule method definition

def batch_get_schema_analysis_rule(
    self,
    *,
    collaborationIdentifier: str,
    schemaAnalysisRuleRequests: Sequence[SchemaAnalysisRuleRequestTypeDef],  # (1)
) -> BatchGetSchemaAnalysisRuleOutputTypeDef:  # (2)
    ...
  1. See SchemaAnalysisRuleRequestTypeDef
  2. See BatchGetSchemaAnalysisRuleOutputTypeDef
# batch_get_schema_analysis_rule method usage example with argument unpacking

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

parent.batch_get_schema_analysis_rule(**kwargs)
  1. See BatchGetSchemaAnalysisRuleInputRequestTypeDef

can_paginate#

Check if an operation can be paginated.

Type annotations and code completion for boto3.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 boto3.client("cleanrooms").close method. boto3 documentation

# close method definition

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

create_analysis_template#

Creates a new analysis template.

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

# create_analysis_template method definition

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 boto3.client("cleanrooms").create_collaboration method. boto3 documentation

# create_collaboration method definition

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] = ...,
    creatorPaymentConfiguration: PaymentConfigurationTypeDef = ...,  # (5)
) -> CreateCollaborationOutputTypeDef:  # (6)
    ...
  1. See MemberSpecificationTypeDef
  2. See MemberAbilityType
  3. See CollaborationQueryLogStatusType
  4. See DataEncryptionMetadataTypeDef
  5. See PaymentConfigurationTypeDef
  6. 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_audience_model_association#

Provides the details necessary to create a configured audience model association.

Type annotations and code completion for boto3.client("cleanrooms").create_configured_audience_model_association method. boto3 documentation

# create_configured_audience_model_association method definition

def create_configured_audience_model_association(
    self,
    *,
    membershipIdentifier: str,
    configuredAudienceModelArn: str,
    configuredAudienceModelAssociationName: str,
    manageResourcePolicies: bool,
    tags: Mapping[str, str] = ...,
    description: str = ...,
) -> CreateConfiguredAudienceModelAssociationOutputTypeDef:  # (1)
    ...
  1. See CreateConfiguredAudienceModelAssociationOutputTypeDef
# create_configured_audience_model_association method usage example with argument unpacking

kwargs: CreateConfiguredAudienceModelAssociationInputRequestTypeDef = {  # (1)
    "membershipIdentifier": ...,
    "configuredAudienceModelArn": ...,
    "configuredAudienceModelAssociationName": ...,
    "manageResourcePolicies": ...,
}

parent.create_configured_audience_model_association(**kwargs)
  1. See CreateConfiguredAudienceModelAssociationInputRequestTypeDef

create_configured_table#

Creates a new configured table resource.

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

# create_configured_table method definition

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 boto3.client("cleanrooms").create_configured_table_analysis_rule method.