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)
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)
...
# batch_get_schema_analysis_rule method usage example with argument unpacking
kwargs: BatchGetSchemaAnalysisRuleInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"schemaAnalysisRuleRequests": ...,
}
parent.batch_get_schema_analysis_rule(**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] = ...,
creatorPaymentConfiguration: PaymentConfigurationTypeDef = ..., # (5)
analyticsEngine: AnalyticsEngineType = ..., # (6)
) -> CreateCollaborationOutputTypeDef: # (7)
...
- See MemberSpecificationTypeDef
- See MemberAbilityType
- See CollaborationQueryLogStatusType
- See DataEncryptionMetadataTypeDef
- See PaymentConfigurationTypeDef
- See AnalyticsEngineType
- 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_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)
...
# 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)
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_configured_table_association_analysis_rule#
Creates a new analysis rule for an associated configured table.
Type annotations and code completion for boto3.client("cleanrooms").create_configured_table_association_analysis_rule
method.
boto3 documentation
# create_configured_table_association_analysis_rule method definition
def create_configured_table_association_analysis_rule(
self,
*,
membershipIdentifier: str,
configuredTableAssociationIdentifier: str,
analysisRuleType: ConfiguredTableAssociationAnalysisRuleTypeType, # (1)
analysisRulePolicy: ConfiguredTableAssociationAnalysisRulePolicyTypeDef, # (2)
) -> CreateConfiguredTableAssociationAnalysisRuleOutputTypeDef: # (3)
...
- See ConfiguredTableAssociationAnalysisRuleTypeType
- See ConfiguredTableAssociationAnalysisRulePolicyTypeDef
- See CreateConfiguredTableAssociationAnalysisRuleOutputTypeDef
# create_configured_table_association_analysis_rule method usage example with argument unpacking
kwargs: CreateConfiguredTableAssociationAnalysisRuleInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"configuredTableAssociationIdentifier": ...,
"analysisRuleType": ...,
"analysisRulePolicy": ...,
}
parent.create_configured_table_association_analysis_rule(**kwargs)
create_id_mapping_table#
Creates an ID mapping table.
Type annotations and code completion for boto3.client("cleanrooms").create_id_mapping_table
method.
boto3 documentation
# create_id_mapping_table method definition
def create_id_mapping_table(
self,
*,
membershipIdentifier: str,
name: str,
inputReferenceConfig: IdMappingTableInputReferenceConfigTypeDef, # (1)
description: str = ...,
tags: Mapping[str, str] = ...,
kmsKeyArn: str = ...,
) -> CreateIdMappingTableOutputTypeDef: # (2)
...
# create_id_mapping_table method usage example with argument unpacking
kwargs: CreateIdMappingTableInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"name": ...,
"inputReferenceConfig": ...,
}
parent.create_id_mapping_table(**kwargs)
create_id_namespace_association#
Creates an ID namespace association.
Type annotations and code completion for boto3.client("cleanrooms").create_id_namespace_association
method.
boto3 documentation
# create_id_namespace_association method definition
def create_id_namespace_association(
self,
*,
membershipIdentifier: str,
inputReferenceConfig: IdNamespaceAssociationInputReferenceConfigTypeDef, # (1)
name: str,
tags: Mapping[str, str] = ...,
description: str = ...,
idMappingConfig: IdMappingConfigTypeDef = ..., # (2)
) -> CreateIdNamespaceAssociationOutputTypeDef: # (3)
...
- See IdNamespaceAssociationInputReferenceConfigTypeDef
- See IdMappingConfigTypeDef
- See CreateIdNamespaceAssociationOutputTypeDef
# create_id_namespace_association method usage example with argument unpacking
kwargs: CreateIdNamespaceAssociationInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"inputReferenceConfig": ...,
"name": ...,
}
parent.create_id_namespace_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)
paymentConfiguration: MembershipPaymentConfigurationTypeDef = ..., # (3)
) -> CreateMembershipOutputTypeDef: # (4)
...
- See MembershipQueryLogStatusType
- See MembershipProtectedQueryResultConfigurationTypeDef
- See MembershipPaymentConfigurationTypeDef
- See CreateMembershipOutputTypeDef
# create_membership method usage example with argument unpacking
kwargs: CreateMembershipInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"queryLogStatus": ...,
}
parent.create_membership(**kwargs)
create_privacy_budget_template#
Creates a privacy budget template for a specified membership.
Type annotations and code completion for boto3.client("cleanrooms").create_privacy_budget_template
method.
boto3 documentation
# create_privacy_budget_template method definition
def create_privacy_budget_template(
self,
*,
membershipIdentifier: str,
autoRefresh: PrivacyBudgetTemplateAutoRefreshType, # (1)
privacyBudgetType: PrivacyBudgetTypeType, # (2)
parameters: PrivacyBudgetTemplateParametersInputTypeDef, # (3)
tags: Mapping[str, str] = ...,
) -> CreatePrivacyBudgetTemplateOutputTypeDef: # (4)
...
- See PrivacyBudgetTemplateAutoRefreshType
- See PrivacyBudgetTypeType
- See PrivacyBudgetTemplateParametersInputTypeDef
- See CreatePrivacyBudgetTemplateOutputTypeDef
# create_privacy_budget_template method usage example with argument unpacking
kwargs: CreatePrivacyBudgetTemplateInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"autoRefresh": ...,
"privacyBudgetType": ...,
"parameters": ...,
}
parent.create_privacy_budget_template(**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_audience_model_association#
Provides the information necessary to delete a configured audience model association.
Type annotations and code completion for boto3.client("cleanrooms").delete_configured_audience_model_association
method.
boto3 documentation
# delete_configured_audience_model_association method definition
def delete_configured_audience_model_association(
self,
*,
configuredAudienceModelAssociationIdentifier: str,
membershipIdentifier: str,
) -> Dict[str, Any]:
...
# delete_configured_audience_model_association method usage example with argument unpacking
kwargs: DeleteConfiguredAudienceModelAssociationInputRequestTypeDef = { # (1)
"configuredAudienceModelAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.delete_configured_audience_model_association(**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_configured_table_association_analysis_rule#
Deletes an analysis rule for a configured table association.
Type annotations and code completion for boto3.client("cleanrooms").delete_configured_table_association_analysis_rule
method.
boto3 documentation
# delete_configured_table_association_analysis_rule method definition
def delete_configured_table_association_analysis_rule(
self,
*,
membershipIdentifier: str,
configuredTableAssociationIdentifier: str,
analysisRuleType: ConfiguredTableAssociationAnalysisRuleTypeType, # (1)
) -> Dict[str, Any]:
...
# delete_configured_table_association_analysis_rule method usage example with argument unpacking
kwargs: DeleteConfiguredTableAssociationAnalysisRuleInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"configuredTableAssociationIdentifier": ...,
"analysisRuleType": ...,
}
parent.delete_configured_table_association_analysis_rule(**kwargs)
delete_id_mapping_table#
Deletes an ID mapping table.
Type annotations and code completion for boto3.client("cleanrooms").delete_id_mapping_table
method.
boto3 documentation
# delete_id_mapping_table method definition
def delete_id_mapping_table(
self,
*,
idMappingTableIdentifier: str,
membershipIdentifier: str,
) -> Dict[str, Any]:
...
# delete_id_mapping_table method usage example with argument unpacking
kwargs: DeleteIdMappingTableInputRequestTypeDef = { # (1)
"idMappingTableIdentifier": ...,
"membershipIdentifier": ...,
}
parent.delete_id_mapping_table(**kwargs)
delete_id_namespace_association#
Deletes an ID namespace association.
Type annotations and code completion for boto3.client("cleanrooms").delete_id_namespace_association
method.
boto3 documentation
# delete_id_namespace_association method definition
def delete_id_namespace_association(
self,
*,
idNamespaceAssociationIdentifier: str,
membershipIdentifier: str,
) -> Dict[str, Any]:
...
# delete_id_namespace_association method usage example with argument unpacking
kwargs: DeleteIdNamespaceAssociationInputRequestTypeDef = { # (1)
"idNamespaceAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.delete_id_namespace_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)
delete_privacy_budget_template#
Deletes a privacy budget template for a specified membership.
Type annotations and code completion for boto3.client("cleanrooms").delete_privacy_budget_template
method.
boto3 documentation
# delete_privacy_budget_template method definition
def delete_privacy_budget_template(
self,
*,
membershipIdentifier: str,
privacyBudgetTemplateIdentifier: str,
) -> Dict[str, Any]:
...
# delete_privacy_budget_template method usage example with argument unpacking
kwargs: DeletePrivacyBudgetTemplateInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"privacyBudgetTemplateIdentifier": ...,
}
parent.delete_privacy_budget_template(**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_collaboration_configured_audience_model_association#
Retrieves a configured audience model association within a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").get_collaboration_configured_audience_model_association
method.
boto3 documentation
# get_collaboration_configured_audience_model_association method definition
def get_collaboration_configured_audience_model_association(
self,
*,
collaborationIdentifier: str,
configuredAudienceModelAssociationIdentifier: str,
) -> GetCollaborationConfiguredAudienceModelAssociationOutputTypeDef: # (1)
...
# get_collaboration_configured_audience_model_association method usage example with argument unpacking
kwargs: GetCollaborationConfiguredAudienceModelAssociationInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"configuredAudienceModelAssociationIdentifier": ...,
}
parent.get_collaboration_configured_audience_model_association(**kwargs)
get_collaboration_id_namespace_association#
Retrieves an ID namespace association from a specific collaboration.
Type annotations and code completion for boto3.client("cleanrooms").get_collaboration_id_namespace_association
method.
boto3 documentation
# get_collaboration_id_namespace_association method definition
def get_collaboration_id_namespace_association(
self,
*,
collaborationIdentifier: str,
idNamespaceAssociationIdentifier: str,
) -> GetCollaborationIdNamespaceAssociationOutputTypeDef: # (1)
...
# get_collaboration_id_namespace_association method usage example with argument unpacking
kwargs: GetCollaborationIdNamespaceAssociationInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"idNamespaceAssociationIdentifier": ...,
}
parent.get_collaboration_id_namespace_association(**kwargs)
get_collaboration_privacy_budget_template#
Returns details about a specified privacy budget template.
Type annotations and code completion for boto3.client("cleanrooms").get_collaboration_privacy_budget_template
method.
boto3 documentation
# get_collaboration_privacy_budget_template method definition
def get_collaboration_privacy_budget_template(
self,
*,
collaborationIdentifier: str,
privacyBudgetTemplateIdentifier: str,
) -> GetCollaborationPrivacyBudgetTemplateOutputTypeDef: # (1)
...
# get_collaboration_privacy_budget_template method usage example with argument unpacking
kwargs: GetCollaborationPrivacyBudgetTemplateInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"privacyBudgetTemplateIdentifier": ...,
}
parent.get_collaboration_privacy_budget_template(**kwargs)
get_configured_audience_model_association#
Returns information about a configured audience model association.
Type annotations and code completion for boto3.client("cleanrooms").get_configured_audience_model_association
method.
boto3 documentation
# get_configured_audience_model_association method definition
def get_configured_audience_model_association(
self,
*,
configuredAudienceModelAssociationIdentifier: str,
membershipIdentifier: str,
) -> GetConfiguredAudienceModelAssociationOutputTypeDef: # (1)
...
# get_configured_audience_model_association method usage example with argument unpacking
kwargs: GetConfiguredAudienceModelAssociationInputRequestTypeDef = { # (1)
"configuredAudienceModelAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.get_configured_audience_model_association(**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_configured_table_association_analysis_rule#
Retrieves the analysis rule for a configured table association.
Type annotations and code completion for boto3.client("cleanrooms").get_configured_table_association_analysis_rule
method.
boto3 documentation
# get_configured_table_association_analysis_rule method definition
def get_configured_table_association_analysis_rule(
self,
*,
membershipIdentifier: str,
configuredTableAssociationIdentifier: str,
analysisRuleType: ConfiguredTableAssociationAnalysisRuleTypeType, # (1)
) -> GetConfiguredTableAssociationAnalysisRuleOutputTypeDef: # (2)
...
- See ConfiguredTableAssociationAnalysisRuleTypeType
- See GetConfiguredTableAssociationAnalysisRuleOutputTypeDef
# get_configured_table_association_analysis_rule method usage example with argument unpacking
kwargs: GetConfiguredTableAssociationAnalysisRuleInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"configuredTableAssociationIdentifier": ...,
"analysisRuleType": ...,
}
parent.get_configured_table_association_analysis_rule(**kwargs)
get_id_mapping_table#
Retrieves an ID mapping table.
Type annotations and code completion for boto3.client("cleanrooms").get_id_mapping_table
method.
boto3 documentation
# get_id_mapping_table method definition
def get_id_mapping_table(
self,
*,
idMappingTableIdentifier: str,
membershipIdentifier: str,
) -> GetIdMappingTableOutputTypeDef: # (1)
...
# get_id_mapping_table method usage example with argument unpacking
kwargs: GetIdMappingTableInputRequestTypeDef = { # (1)
"idMappingTableIdentifier": ...,
"membershipIdentifier": ...,
}
parent.get_id_mapping_table(**kwargs)
get_id_namespace_association#
Retrieves an ID namespace association.
Type annotations and code completion for boto3.client("cleanrooms").get_id_namespace_association
method.
boto3 documentation
# get_id_namespace_association method definition
def get_id_namespace_association(
self,
*,
idNamespaceAssociationIdentifier: str,
membershipIdentifier: str,
) -> GetIdNamespaceAssociationOutputTypeDef: # (1)
...
# get_id_namespace_association method usage example with argument unpacking
kwargs: GetIdNamespaceAssociationInputRequestTypeDef = { # (1)
"idNamespaceAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.get_id_namespace_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_privacy_budget_template#
Returns details for a specified privacy budget template.
Type annotations and code completion for boto3.client("cleanrooms").get_privacy_budget_template
method.
boto3 documentation
# get_privacy_budget_template method definition
def get_privacy_budget_template(
self,
*,
membershipIdentifier: str,
privacyBudgetTemplateIdentifier: str,
) -> GetPrivacyBudgetTemplateOutputTypeDef: # (1)
...
# get_privacy_budget_template method usage example with argument unpacking
kwargs: GetPrivacyBudgetTemplateInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"privacyBudgetTemplateIdentifier": ...,
}
parent.get_privacy_budget_template(**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)
...
# list_analysis_templates method usage example with argument unpacking
kwargs: ListAnalysisTemplatesInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.list_analysis_templates(**kwargs)
list_collaboration_analysis_templates#
Lists analysis templates within a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").list_collaboration_analysis_templates
method.
boto3 documentation
# list_collaboration_analysis_templates method definition
def list_collaboration_analysis_templates(
self,
*,
collaborationIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListCollaborationAnalysisTemplatesOutputTypeDef: # (1)
...
# list_collaboration_analysis_templates method usage example with argument unpacking
kwargs: ListCollaborationAnalysisTemplatesInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.list_collaboration_analysis_templates(**kwargs)
list_collaboration_configured_audience_model_associations#
Lists configured audience model associations within a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").list_collaboration_configured_audience_model_associations
method.
boto3 documentation
# list_collaboration_configured_audience_model_associations method definition
def list_collaboration_configured_audience_model_associations(
self,
*,
collaborationIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListCollaborationConfiguredAudienceModelAssociationsOutputTypeDef: # (1)
...
# list_collaboration_configured_audience_model_associations method usage example with argument unpacking
kwargs: ListCollaborationConfiguredAudienceModelAssociationsInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.list_collaboration_configured_audience_model_associations(**kwargs)
list_collaboration_id_namespace_associations#
Returns a list of the ID namespace associations in a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").list_collaboration_id_namespace_associations
method.
boto3 documentation
# list_collaboration_id_namespace_associations method definition
def list_collaboration_id_namespace_associations(
self,
*,
collaborationIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListCollaborationIdNamespaceAssociationsOutputTypeDef: # (1)
...
# list_collaboration_id_namespace_associations method usage example with argument unpacking
kwargs: ListCollaborationIdNamespaceAssociationsInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.list_collaboration_id_namespace_associations(**kwargs)
list_collaboration_privacy_budget_templates#
Returns an array that summarizes each privacy budget template in a specified collaboration.
Type annotations and code completion for boto3.client("cleanrooms").list_collaboration_privacy_budget_templates
method.
boto3 documentation
# list_collaboration_privacy_budget_templates method definition
def list_collaboration_privacy_budget_templates(
self,
*,
collaborationIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListCollaborationPrivacyBudgetTemplatesOutputTypeDef: # (1)
...
# list_collaboration_privacy_budget_templates method usage example with argument unpacking
kwargs: ListCollaborationPrivacyBudgetTemplatesInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.list_collaboration_privacy_budget_templates(**kwargs)
list_collaboration_privacy_budgets#
Returns an array that summarizes each privacy budget in a specified collaboration.
Type annotations and code completion for boto3.client("cleanrooms").list_collaboration_privacy_budgets
method.
boto3 documentation
# list_collaboration_privacy_budgets method definition
def list_collaboration_privacy_budgets(
self,
*,
collaborationIdentifier: str,
privacyBudgetType: PrivacyBudgetTypeType, # (1)
maxResults: int = ...,
nextToken: str = ...,
) -> ListCollaborationPrivacyBudgetsOutputTypeDef: # (2)
...
# list_collaboration_privacy_budgets method usage example with argument unpacking
kwargs: ListCollaborationPrivacyBudgetsInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
"privacyBudgetType": ...,
}
parent.list_collaboration_privacy_budgets(**kwargs)
list_collaborations#
Lists collaborations the caller owns, is active in, or has been invited to.
Type annotations and code completion for boto3.client("cleanrooms").list_collaborations
method.
boto3 documentation
# list_collaborations method definition
def list_collaborations(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
memberStatus: FilterableMemberStatusType = ..., # (1)
) -> ListCollaborationsOutputTypeDef: # (2)
...
# list_collaborations method usage example with argument unpacking
kwargs: ListCollaborationsInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_collaborations(**kwargs)
list_configured_audience_model_associations#
Lists information about requested configured audience model associations.
Type annotations and code completion for boto3.client("cleanrooms").list_configured_audience_model_associations
method.
boto3 documentation
# list_configured_audience_model_associations method definition
def list_configured_audience_model_associations(
self,
*,
membershipIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListConfiguredAudienceModelAssociationsOutputTypeDef: # (1)
...
# list_configured_audience_model_associations method usage example with argument unpacking
kwargs: ListConfiguredAudienceModelAssociationsInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.list_configured_audience_model_associations(**kwargs)
list_configured_table_associations#
Lists configured table associations for a membership.
Type annotations and code completion for boto3.client("cleanrooms").list_configured_table_associations
method.
boto3 documentation
# list_configured_table_associations method definition
def list_configured_table_associations(
self,
*,
membershipIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListConfiguredTableAssociationsOutputTypeDef: # (1)
...
# list_configured_table_associations method usage example with argument unpacking
kwargs: ListConfiguredTableAssociationsInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.list_configured_table_associations(**kwargs)
list_configured_tables#
Lists configured tables.
Type annotations and code completion for boto3.client("cleanrooms").list_configured_tables
method.
boto3 documentation
# list_configured_tables method definition
def list_configured_tables(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
) -> ListConfiguredTablesOutputTypeDef: # (1)
...
# list_configured_tables method usage example with argument unpacking
kwargs: ListConfiguredTablesInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_configured_tables(**kwargs)
list_id_mapping_tables#
Returns a list of ID mapping tables.
Type annotations and code completion for boto3.client("cleanrooms").list_id_mapping_tables
method.
boto3 documentation
# list_id_mapping_tables method definition
def list_id_mapping_tables(
self,
*,
membershipIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListIdMappingTablesOutputTypeDef: # (1)
...
# list_id_mapping_tables method usage example with argument unpacking
kwargs: ListIdMappingTablesInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.list_id_mapping_tables(**kwargs)
list_id_namespace_associations#
Returns a list of ID namespace associations.
Type annotations and code completion for boto3.client("cleanrooms").list_id_namespace_associations
method.
boto3 documentation
# list_id_namespace_associations method definition
def list_id_namespace_associations(
self,
*,
membershipIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListIdNamespaceAssociationsOutputTypeDef: # (1)
...
# list_id_namespace_associations method usage example with argument unpacking
kwargs: ListIdNamespaceAssociationsInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.list_id_namespace_associations(**kwargs)
list_members#
Lists all members within a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").list_members
method.
boto3 documentation
# list_members method definition
def list_members(
self,
*,
collaborationIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListMembersOutputTypeDef: # (1)
...
# list_members method usage example with argument unpacking
kwargs: ListMembersInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.list_members(**kwargs)
list_memberships#
Lists all memberships resources within the caller's account.
Type annotations and code completion for boto3.client("cleanrooms").list_memberships
method.
boto3 documentation
# list_memberships method definition
def list_memberships(
self,
*,
nextToken: str = ...,
maxResults: int = ...,
status: MembershipStatusType = ..., # (1)
) -> ListMembershipsOutputTypeDef: # (2)
...
# list_memberships method usage example with argument unpacking
kwargs: ListMembershipsInputRequestTypeDef = { # (1)
"nextToken": ...,
}
parent.list_memberships(**kwargs)
list_privacy_budget_templates#
Returns detailed information about the privacy budget templates in a specified membership.
Type annotations and code completion for boto3.client("cleanrooms").list_privacy_budget_templates
method.
boto3 documentation
# list_privacy_budget_templates method definition
def list_privacy_budget_templates(
self,
*,
membershipIdentifier: str,
nextToken: str = ...,
maxResults: int = ...,
) -> ListPrivacyBudgetTemplatesOutputTypeDef: # (1)
...
# list_privacy_budget_templates method usage example with argument unpacking
kwargs: ListPrivacyBudgetTemplatesInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.list_privacy_budget_templates(**kwargs)
list_privacy_budgets#
Returns detailed information about the privacy budgets in a specified membership.
Type annotations and code completion for boto3.client("cleanrooms").list_privacy_budgets
method.
boto3 documentation
# list_privacy_budgets method definition
def list_privacy_budgets(
self,
*,
membershipIdentifier: str,
privacyBudgetType: PrivacyBudgetTypeType, # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListPrivacyBudgetsOutputTypeDef: # (2)
...
# list_privacy_budgets method usage example with argument unpacking
kwargs: ListPrivacyBudgetsInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"privacyBudgetType": ...,
}
parent.list_privacy_budgets(**kwargs)
list_protected_queries#
Lists protected queries, sorted by the most recent query.
Type annotations and code completion for boto3.client("cleanrooms").list_protected_queries
method.
boto3 documentation
# list_protected_queries method definition
def list_protected_queries(
self,
*,
membershipIdentifier: str,
status: ProtectedQueryStatusType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListProtectedQueriesOutputTypeDef: # (2)
...
# list_protected_queries method usage example with argument unpacking
kwargs: ListProtectedQueriesInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.list_protected_queries(**kwargs)
list_schemas#
Lists the schemas for relations within a collaboration.
Type annotations and code completion for boto3.client("cleanrooms").list_schemas
method.
boto3 documentation
# list_schemas method definition
def list_schemas(
self,
*,
collaborationIdentifier: str,
schemaType: SchemaTypeType = ..., # (1)
nextToken: str = ...,
maxResults: int = ...,
) -> ListSchemasOutputTypeDef: # (2)
...
# list_schemas method usage example with argument unpacking
kwargs: ListSchemasInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.list_schemas(**kwargs)
list_tags_for_resource#
Lists all of the tags that have been added to a resource.
Type annotations and code completion for boto3.client("cleanrooms").list_tags_for_resource
method.
boto3 documentation
# list_tags_for_resource method definition
def list_tags_for_resource(
self,
*,
resourceArn: str,
) -> ListTagsForResourceOutputTypeDef: # (1)
...
# list_tags_for_resource method usage example with argument unpacking
kwargs: ListTagsForResourceInputRequestTypeDef = { # (1)
"resourceArn": ...,
}
parent.list_tags_for_resource(**kwargs)
populate_id_mapping_table#
Defines the information that's necessary to populate an ID mapping table.
Type annotations and code completion for boto3.client("cleanrooms").populate_id_mapping_table
method.
boto3 documentation
# populate_id_mapping_table method definition
def populate_id_mapping_table(
self,
*,
idMappingTableIdentifier: str,
membershipIdentifier: str,
) -> PopulateIdMappingTableOutputTypeDef: # (1)
...
# populate_id_mapping_table method usage example with argument unpacking
kwargs: PopulateIdMappingTableInputRequestTypeDef = { # (1)
"idMappingTableIdentifier": ...,
"membershipIdentifier": ...,
}
parent.populate_id_mapping_table(**kwargs)
preview_privacy_impact#
An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
Type annotations and code completion for boto3.client("cleanrooms").preview_privacy_impact
method.
boto3 documentation
# preview_privacy_impact method definition
def preview_privacy_impact(
self,
*,
membershipIdentifier: str,
parameters: PreviewPrivacyImpactParametersInputTypeDef, # (1)
) -> PreviewPrivacyImpactOutputTypeDef: # (2)
...
# preview_privacy_impact method usage example with argument unpacking
kwargs: PreviewPrivacyImpactInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"parameters": ...,
}
parent.preview_privacy_impact(**kwargs)
start_protected_query#
Creates a protected query that is started by Clean Rooms.
Type annotations and code completion for boto3.client("cleanrooms").start_protected_query
method.
boto3 documentation
# start_protected_query method definition
def start_protected_query(
self,
*,
type: ProtectedQueryTypeType, # (1)
membershipIdentifier: str,
sqlParameters: ProtectedQuerySQLParametersTypeDef, # (2)
resultConfiguration: ProtectedQueryResultConfigurationTypeDef = ..., # (3)
computeConfiguration: ComputeConfigurationTypeDef = ..., # (4)
) -> StartProtectedQueryOutputTypeDef: # (5)
...
- See ProtectedQueryTypeType
- See ProtectedQuerySQLParametersTypeDef
- See ProtectedQueryResultConfigurationTypeDef
- See ComputeConfigurationTypeDef
- See StartProtectedQueryOutputTypeDef
# start_protected_query method usage example with argument unpacking
kwargs: StartProtectedQueryInputRequestTypeDef = { # (1)
"type": ...,
"membershipIdentifier": ...,
"sqlParameters": ...,
}
parent.start_protected_query(**kwargs)
tag_resource#
Tags a resource.
Type annotations and code completion for boto3.client("cleanrooms").tag_resource
method.
boto3 documentation
# tag_resource method definition
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)
untag_resource#
Removes a tag or list of tags from a resource.
Type annotations and code completion for boto3.client("cleanrooms").untag_resource
method.
boto3 documentation
# untag_resource method definition
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)
update_analysis_template#
Updates the analysis template metadata.
Type annotations and code completion for boto3.client("cleanrooms").update_analysis_template
method.
boto3 documentation
# update_analysis_template method definition
def update_analysis_template(
self,
*,
membershipIdentifier: str,
analysisTemplateIdentifier: str,
description: str = ...,
) -> UpdateAnalysisTemplateOutputTypeDef: # (1)
...
# update_analysis_template method usage example with argument unpacking
kwargs: UpdateAnalysisTemplateInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"analysisTemplateIdentifier": ...,
}
parent.update_analysis_template(**kwargs)
update_collaboration#
Updates collaboration metadata and can only be called by the collaboration owner.
Type annotations and code completion for boto3.client("cleanrooms").update_collaboration
method.
boto3 documentation
# update_collaboration method definition
def update_collaboration(
self,
*,
collaborationIdentifier: str,
name: str = ...,
description: str = ...,
) -> UpdateCollaborationOutputTypeDef: # (1)
...
# update_collaboration method usage example with argument unpacking
kwargs: UpdateCollaborationInputRequestTypeDef = { # (1)
"collaborationIdentifier": ...,
}
parent.update_collaboration(**kwargs)
update_configured_audience_model_association#
Provides the details necessary to update a configured audience model association.
Type annotations and code completion for boto3.client("cleanrooms").update_configured_audience_model_association
method.
boto3 documentation
# update_configured_audience_model_association method definition
def update_configured_audience_model_association(
self,
*,
configuredAudienceModelAssociationIdentifier: str,
membershipIdentifier: str,
description: str = ...,
name: str = ...,
) -> UpdateConfiguredAudienceModelAssociationOutputTypeDef: # (1)
...
# update_configured_audience_model_association method usage example with argument unpacking
kwargs: UpdateConfiguredAudienceModelAssociationInputRequestTypeDef = { # (1)
"configuredAudienceModelAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.update_configured_audience_model_association(**kwargs)
update_configured_table#
Updates a configured table.
Type annotations and code completion for boto3.client("cleanrooms").update_configured_table
method.
boto3 documentation
# update_configured_table method definition
def update_configured_table(
self,
*,
configuredTableIdentifier: str,
name: str = ...,
description: str = ...,
) -> UpdateConfiguredTableOutputTypeDef: # (1)
...
# update_configured_table method usage example with argument unpacking
kwargs: UpdateConfiguredTableInputRequestTypeDef = { # (1)
"configuredTableIdentifier": ...,
}
parent.update_configured_table(**kwargs)
update_configured_table_analysis_rule#
Updates a configured table analysis rule.
Type annotations and code completion for boto3.client("cleanrooms").update_configured_table_analysis_rule
method.
boto3 documentation
# update_configured_table_analysis_rule method definition
def update_configured_table_analysis_rule(
self,
*,
configuredTableIdentifier: str,
analysisRuleType: ConfiguredTableAnalysisRuleTypeType, # (1)
analysisRulePolicy: ConfiguredTableAnalysisRulePolicyTypeDef, # (2)
) -> UpdateConfiguredTableAnalysisRuleOutputTypeDef: # (3)
...
- See ConfiguredTableAnalysisRuleTypeType
- See ConfiguredTableAnalysisRulePolicyTypeDef
- 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)
update_configured_table_association#
Updates a configured table association.
Type annotations and code completion for boto3.client("cleanrooms").update_configured_table_association
method.
boto3 documentation
# update_configured_table_association method definition
def update_configured_table_association(
self,
*,
configuredTableAssociationIdentifier: str,
membershipIdentifier: str,
description: str = ...,
roleArn: str = ...,
) -> UpdateConfiguredTableAssociationOutputTypeDef: # (1)
...
# update_configured_table_association method usage example with argument unpacking
kwargs: UpdateConfiguredTableAssociationInputRequestTypeDef = { # (1)
"configuredTableAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.update_configured_table_association(**kwargs)
update_configured_table_association_analysis_rule#
Updates the analysis rule for a configured table association.
Type annotations and code completion for boto3.client("cleanrooms").update_configured_table_association_analysis_rule
method.
boto3 documentation
# update_configured_table_association_analysis_rule method definition
def update_configured_table_association_analysis_rule(
self,
*,
membershipIdentifier: str,
configuredTableAssociationIdentifier: str,
analysisRuleType: ConfiguredTableAssociationAnalysisRuleTypeType, # (1)
analysisRulePolicy: ConfiguredTableAssociationAnalysisRulePolicyTypeDef, # (2)
) -> UpdateConfiguredTableAssociationAnalysisRuleOutputTypeDef: # (3)
...
- See ConfiguredTableAssociationAnalysisRuleTypeType
- See ConfiguredTableAssociationAnalysisRulePolicyTypeDef
- See UpdateConfiguredTableAssociationAnalysisRuleOutputTypeDef
# update_configured_table_association_analysis_rule method usage example with argument unpacking
kwargs: UpdateConfiguredTableAssociationAnalysisRuleInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"configuredTableAssociationIdentifier": ...,
"analysisRuleType": ...,
"analysisRulePolicy": ...,
}
parent.update_configured_table_association_analysis_rule(**kwargs)
update_id_mapping_table#
Provides the details that are necessary to update an ID mapping table.
Type annotations and code completion for boto3.client("cleanrooms").update_id_mapping_table
method.
boto3 documentation
# update_id_mapping_table method definition
def update_id_mapping_table(
self,
*,
idMappingTableIdentifier: str,
membershipIdentifier: str,
description: str = ...,
kmsKeyArn: str = ...,
) -> UpdateIdMappingTableOutputTypeDef: # (1)
...
# update_id_mapping_table method usage example with argument unpacking
kwargs: UpdateIdMappingTableInputRequestTypeDef = { # (1)
"idMappingTableIdentifier": ...,
"membershipIdentifier": ...,
}
parent.update_id_mapping_table(**kwargs)
update_id_namespace_association#
Provides the details that are necessary to update an ID namespace association.
Type annotations and code completion for boto3.client("cleanrooms").update_id_namespace_association
method.
boto3 documentation
# update_id_namespace_association method definition
def update_id_namespace_association(
self,
*,
idNamespaceAssociationIdentifier: str,
membershipIdentifier: str,
name: str = ...,
description: str = ...,
idMappingConfig: IdMappingConfigTypeDef = ..., # (1)
) -> UpdateIdNamespaceAssociationOutputTypeDef: # (2)
...
# update_id_namespace_association method usage example with argument unpacking
kwargs: UpdateIdNamespaceAssociationInputRequestTypeDef = { # (1)
"idNamespaceAssociationIdentifier": ...,
"membershipIdentifier": ...,
}
parent.update_id_namespace_association(**kwargs)
update_membership#
Updates a membership.
Type annotations and code completion for boto3.client("cleanrooms").update_membership
method.
boto3 documentation
# update_membership method definition
def update_membership(
self,
*,
membershipIdentifier: str,
queryLogStatus: MembershipQueryLogStatusType = ..., # (1)
defaultResultConfiguration: MembershipProtectedQueryResultConfigurationTypeDef = ..., # (2)
) -> UpdateMembershipOutputTypeDef: # (3)
...
- See MembershipQueryLogStatusType
- See MembershipProtectedQueryResultConfigurationTypeDef
- See UpdateMembershipOutputTypeDef
# update_membership method usage example with argument unpacking
kwargs: UpdateMembershipInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
}
parent.update_membership(**kwargs)
update_privacy_budget_template#
Updates the privacy budget template for the specified membership.
Type annotations and code completion for boto3.client("cleanrooms").update_privacy_budget_template
method.
boto3 documentation
# update_privacy_budget_template method definition
def update_privacy_budget_template(
self,
*,
membershipIdentifier: str,
privacyBudgetTemplateIdentifier: str,
privacyBudgetType: PrivacyBudgetTypeType, # (1)
parameters: PrivacyBudgetTemplateUpdateParametersTypeDef = ..., # (2)
) -> UpdatePrivacyBudgetTemplateOutputTypeDef: # (3)
...
- See PrivacyBudgetTypeType
- See PrivacyBudgetTemplateUpdateParametersTypeDef
- See UpdatePrivacyBudgetTemplateOutputTypeDef
# update_privacy_budget_template method usage example with argument unpacking
kwargs: UpdatePrivacyBudgetTemplateInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"privacyBudgetTemplateIdentifier": ...,
"privacyBudgetType": ...,
}
parent.update_privacy_budget_template(**kwargs)
update_protected_query#
Updates the processing of a currently running query.
Type annotations and code completion for boto3.client("cleanrooms").update_protected_query
method.
boto3 documentation
# update_protected_query method definition
def update_protected_query(
self,
*,
membershipIdentifier: str,
protectedQueryIdentifier: str,
targetStatus: TargetProtectedQueryStatusType, # (1)
) -> UpdateProtectedQueryOutputTypeDef: # (2)
...
# update_protected_query method usage example with argument unpacking
kwargs: UpdateProtectedQueryInputRequestTypeDef = { # (1)
"membershipIdentifier": ...,
"protectedQueryIdentifier": ...,
"targetStatus": ...,
}
parent.update_protected_query(**kwargs)
get_paginator#
Type annotations and code completion for boto3.client("cleanrooms").get_paginator
method with overloads.
client.get_paginator("list_analysis_templates")
-> ListAnalysisTemplatesPaginatorclient.get_paginator("list_collaboration_analysis_templates")
-> ListCollaborationAnalysisTemplatesPaginatorclient.get_paginator("list_collaboration_configured_audience_model_associations")
-> ListCollaborationConfiguredAudienceModelAssociationsPaginatorclient.get_paginator("list_collaboration_id_namespace_associations")
-> ListCollaborationIdNamespaceAssociationsPaginatorclient.get_paginator("list_collaboration_privacy_budget_templates")
-> ListCollaborationPrivacyBudgetTemplatesPaginatorclient.get_paginator("list_collaboration_privacy_budgets")
-> ListCollaborationPrivacyBudgetsPaginatorclient.get_paginator("list_collaborations")
-> ListCollaborationsPaginatorclient.get_paginator("list_configured_audience_model_associations")
-> ListConfiguredAudienceModelAssociationsPaginatorclient.get_paginator("list_configured_table_associations")
-> ListConfiguredTableAssociationsPaginatorclient.get_paginator("list_configured_tables")
-> ListConfiguredTablesPaginatorclient.get_paginator("list_id_mapping_tables")
-> ListIdMappingTablesPaginatorclient.get_paginator("list_id_namespace_associations")
-> ListIdNamespaceAssociationsPaginatorclient.get_paginator("list_members")
-> ListMembersPaginatorclient.get_paginator("list_memberships")
-> ListMembershipsPaginatorclient.get_paginator("list_privacy_budget_templates")
-> ListPrivacyBudgetTemplatesPaginatorclient.get_paginator("list_privacy_budgets")
-> ListPrivacyBudgetsPaginatorclient.get_paginator("list_protected_queries")
-> ListProtectedQueriesPaginatorclient.get_paginator("list_schemas")
-> ListSchemasPaginator