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)
...
# batch_get_collaboration_analysis_template method usage example with argument unpacking
kwargs: BatchGetCollaborationAnalysisTemplateInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"analysisTemplateArns": ...,
}
parent.batch_get_collaboration_analysis_template(**kwargs)
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)
...
# batch_get_schema method usage example with argument unpacking
kwargs: BatchGetSchemaInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"names": ...,
}
parent.batch_get_schema(**kwargs)
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)
...
- See AnalysisFormatType
- See AnalysisSourceTypeDef
- See AnalysisParameterTypeDef
- See CreateAnalysisTemplateOutputTypeDef
# create_analysis_template method usage example with argument unpacking
kwargs: CreateAnalysisTemplateInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"name": ...,
"format": ...,
"source": ...,
}
parent.create_analysis_template(**kwargs)
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] = ...,
) -> CreateCollaborationOutputTypeDef: # (5)
...
- See MemberSpecificationTypeDef
- See MemberAbilityType
- See CollaborationQueryLogStatusType
- See DataEncryptionMetadataTypeDef
- See CreateCollaborationOutputTypeDef
# create_collaboration method usage example with argument unpacking
kwargs: CreateCollaborationInputRequestTypeDef = { # (1)
"members": ...,
"name": ...,
"description": ...,
"creatorMemberAbilities": ...,
"creatorDisplayName": ...,
"queryLogStatus": ...,
}
parent.create_collaboration(**kwargs)
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)
...
# create_configured_table method usage example with argument unpacking
kwargs: CreateConfiguredTableInputRequestTypeDef = { # (1)
"name": ...,
"tableReference": ...,
"allowedColumns": ...,
"analysisMethod": ...,
}
parent.create_configured_table(**kwargs)
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.
boto3 documentation
# create_configured_table_analysis_rule method definition
def create_configured_table_analysis_rule(
self,
*,
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef, # (2)
) -> CreateConfiguredTableAnalysisRuleOutputTypeDef: # (3)
...
- See ConfiguredTableAnalysisRuleTypeType
- See ConfiguredTableAnalysisRulePolicyTypeDef
- 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)
create_configured_table_association#
Creates a configured table association.
Type annotations and code completion for boto3.client("cleanrooms").create_configured_table_association
method.
boto3 documentation
# create_configured_table_association method definition
def create_configured_table_association(
self,
*,
name: str,
membershipIdentifier: str,
configuredTableIdentifier: str,
roleArn: str,
description: str = ...,
tags: Mapping[str, str] = ...,
) -> CreateConfiguredTableAssociationOutputTypeDef: # (1)
...
# create_configured_table_association method usage example with argument unpacking
kwargs: CreateConfiguredTableAssociationInputRequestTypeDef = { # (1)
"name": ...,
"membershipIdentifier": ...,
"configuredTableIdentifier": ...,
"roleArn": ...,
}
parent.create_configured_table_association(**kwargs)
create_membership#
Creates a membership for a specific collaboration identifier and joins the collaboration.
Type annotations and code completion for boto3.client("cleanrooms").create_membership
method.
boto3 documentation
# create_membership method definition
def create_membership(
self,
*,
collaborationIdentifier: str,
queryLogStatus: MembershipQueryLogStatusType, # (1)
tags: Mapping[str, str] = ...,
defaultResultConfiguration: MembershipProtectedQueryResultConfigurationTypeDef = ..., # (2)
) -> CreateMembershipOutputTypeDef: # (3)
...
- See MembershipQueryLogStatusType
- See MembershipProtectedQueryResultConfigurationTypeDef
- See CreateMembershipOutputTypeDef
# create_membership method usage example with argument unpacking
kwargs: CreateMembershipInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"queryLogStatus": ...,
}
parent.create_membership(**kwargs)
delete_analysis_template#
Deletes an analysis template.
Type annotations and code completion for boto3.client("cleanrooms").delete_analysis_template
method.
boto3 documentation
# delete_analysis_template method definition
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)
delete_collaboration#
Deletes a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").delete_collaboration
method.
boto3 documentation
# delete_collaboration method definition
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)
delete_configured_table#
Deletes a configured table.
Type annotations and code completion for boto3.client("cleanrooms").delete_configured_table
method.
boto3 documentation
# delete_configured_table method definition
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)
delete_configured_table_analysis_rule#
Deletes a configured table analysis rule.
Type annotations and code completion for boto3.client("cleanrooms").delete_configured_table_analysis_rule
method.
boto3 documentation
# delete_configured_table_analysis_rule method definition
def delete_configured_table_analysis_rule(
self,
*,
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
) -> Dict[str, Any]:
...
# delete_configured_table_analysis_rule method usage example with argument unpacking
kwargs: DeleteConfiguredTableAnalysisRuleInputRequestTypeDef = { # (1)
"configuredTableIdentifier": ...,
"analysisRuleType": ...,
}
parent.delete_configured_table_analysis_rule(**kwargs)
delete_configured_table_association#
Deletes a configured table association.
Type annotations and code completion for boto3.client("cleanrooms").delete_configured_table_association
method.
boto3 documentation
# delete_configured_table_association method definition
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)
delete_member#
Removes the specified member from a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").delete_member
method.
boto3 documentation
# delete_member method definition
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)
delete_membership#
Deletes a specified membership.
Type annotations and code completion for boto3.client("cleanrooms").delete_membership
method.
boto3 documentation
# delete_membership method definition
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)
generate_presigned_url#
Generate a presigned url given a client, its method, and arguments.
Type annotations and code completion for boto3.client("cleanrooms").generate_presigned_url
method.
boto3 documentation
# generate_presigned_url method definition
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 boto3.client("cleanrooms").get_analysis_template
method.
boto3 documentation
# get_analysis_template method definition
def get_analysis_template(
self,
*,
membershipIdentifier: str,
analysisTemplateIdentifier: str,
) -> GetAnalysisTemplateOutputTypeDef: # (1)
...
# get_analysis_template method usage example with argument unpacking
kwargs: GetAnalysisTemplateInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"analysisTemplateIdentifier": ...,
}
parent.get_analysis_template(**kwargs)
get_collaboration#
Returns metadata about a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").get_collaboration
method.
boto3 documentation
# get_collaboration method definition
def get_collaboration(
self,
*,
collaborationIdentifier: str,
) -> GetCollaborationOutputTypeDef: # (1)
...
# get_collaboration method usage example with argument unpacking
kwargs: GetCollaborationInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.get_collaboration(**kwargs)
get_collaboration_analysis_template#
Retrieves an analysis template within a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").get_collaboration_analysis_template
method.
boto3 documentation
# get_collaboration_analysis_template method definition
def get_collaboration_analysis_template(
self,
*,
collaborationIdentifier: str,
analysisTemplateArn: str,
) -> GetCollaborationAnalysisTemplateOutputTypeDef: # (1)
...
# get_collaboration_analysis_template method usage example with argument unpacking
kwargs: GetCollaborationAnalysisTemplateInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"analysisTemplateArn": ...,
}
parent.get_collaboration_analysis_template(**kwargs)
get_configured_table#
Retrieves a configured table.
Type annotations and code completion for boto3.client("cleanrooms").get_configured_table
method.
boto3 documentation
# get_configured_table method definition
def get_configured_table(
self,
*,
configuredTableIdentifier: str,
) -> GetConfiguredTableOutputTypeDef: # (1)
...
# get_configured_table method usage example with argument unpacking
kwargs: GetConfiguredTableInputRequestTypeDef = { # (1)
"configuredTableIdentifier": ...,
}
parent.get_configured_table(**kwargs)
get_configured_table_analysis_rule#
Retrieves a configured table analysis rule.
Type annotations and code completion for boto3.client("cleanrooms").get_configured_table_analysis_rule
method.
boto3 documentation
# get_configured_table_analysis_rule method definition
def get_configured_table_analysis_rule(
self,
*,
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
) -> GetConfiguredTableAnalysisRuleOutputTypeDef: # (2)
...
# get_configured_table_analysis_rule method usage example with argument unpacking
kwargs: GetConfiguredTableAnalysisRuleInputRequestTypeDef = { # (1)
"configuredTableIdentifier": ...,
"analysisRuleType": ...,
}
parent.get_configured_table_analysis_rule(**kwargs)
get_configured_table_association#
Retrieves a configured table association.
Type annotations and code completion for boto3.client("cleanrooms").get_configured_table_association
method.
boto3 documentation
# get_configured_table_association method definition
def get_configured_table_association(
self,
*,
configuredTableAssociationIdentifier: str,
membershipIdentifier: str,
) -> GetConfiguredTableAssociationOutputTypeDef: # (1)
...
# get_configured_table_association method usage example with argument unpacking
kwargs: GetConfiguredTableAssociationInputRequestTypeDef = { # (1)
"configuredTableAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.get_configured_table_association(**kwargs)
get_membership#
Retrieves a specified membership for an identifier.
Type annotations and code completion for boto3.client("cleanrooms").get_membership
method.
boto3 documentation
# get_membership method definition
def get_membership(
self,
*,
membershipIdentifier: str,
) -> GetMembershipOutputTypeDef: # (1)
...
# get_membership method usage example with argument unpacking
kwargs: GetMembershipInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.get_membership(**kwargs)
get_protected_query#
Returns query processing metadata.
Type annotations and code completion for boto3.client("cleanrooms").get_protected_query
method.
boto3 documentation
# get_protected_query method definition
def get_protected_query(
self,
*,
membershipIdentifier: str,
protectedQueryIdentifier: str,
) -> GetProtectedQueryOutputTypeDef: # (1)
...
# get_protected_query method usage example with argument unpacking
kwargs: GetProtectedQueryInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"protectedQueryIdentifier": ...,
}
parent.get_protected_query(**kwargs)
get_schema#
Retrieves the schema for a relation within a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").get_schema
method.
boto3 documentation
# get_schema method definition
def get_schema(
self,
*,
collaborationIdentifier: str,
name: str,
) -> GetSchemaOutputTypeDef: # (1)
...
# get_schema method usage example with argument unpacking
kwargs: GetSchemaInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"name": ...,
}
parent.get_schema(**kwargs)
get_schema_analysis_rule#
Retrieves a schema analysis rule.
Type annotations and code completion for boto3.client("cleanrooms").get_schema_analysis_rule
method.
boto3 documentation
# get_schema_analysis_rule method definition
def get_schema_analysis_rule(
self,
*,
collaborationIdentifier: str,
name: str,
type: AnalysisRuleTypeType, # (1)
) -> GetSchemaAnalysisRuleOutputTypeDef: # (2)
...
# get_schema_analysis_rule method usage example with argument unpacking
kwargs: GetSchemaAnalysisRuleInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"name": ...,
"type": ...,
}
parent.get_schema_analysis_rule(**kwargs)
list_analysis_templates#
Lists analysis templates that the caller owns.
Type annotations and code completion for boto3.client("cleanrooms").list_analysis_templates
method.
boto3 documentation
# list_analysis_templates method definition
def list_analysis_templates(
self,
*,
membershipIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListAnalysisTemplatesOutputTypeDef: # (1)
...