CleanRoomsService module#
Index > CleanRoomsService
Auto-generated documentation for CleanRoomsService type annotations stubs module mypy-boto3-cleanrooms.
How to install#
VSCode extension#
Add AWS Boto3
extension to your VSCode and run AWS boto3: Quick Start
command.
Click Modify
and select boto3 common
and CleanRoomsService
.
From PyPI with pip#
Install boto3-stubs
for CleanRoomsService
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cleanrooms]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[cleanrooms]'
# standalone installation
python -m pip install mypy-boto3-cleanrooms
How to uninstall#
python -m pip uninstall -y mypy-boto3-cleanrooms
Usage#
Code samples can be found in Examples.
CleanRoomsServiceClient#
Type annotations and code completion for boto3.client("cleanrooms")
as CleanRoomsServiceClient
boto3 documentation
# CleanRoomsServiceClient usage example
from boto3.session import Session
from mypy_boto3_cleanrooms.client import CleanRoomsServiceClient
def get_client() -> CleanRoomsServiceClient:
return Session().client("cleanrooms")
Paginators#
Type annotations and code completion for paginators
from boto3.client("cleanrooms").get_paginator("...")
.
# ListAnalysisTemplatesPaginator usage example
from boto3.session import Session
from mypy_boto3_cleanrooms.paginator import ListAnalysisTemplatesPaginator
def get_list_analysis_templates_paginator() -> ListAnalysisTemplatesPaginator:
return Session().client("cleanrooms").get_paginator("list_analysis_templates"))
- ListAnalysisTemplatesPaginator
- ListCollaborationAnalysisTemplatesPaginator
- ListCollaborationConfiguredAudienceModelAssociationsPaginator
- ListCollaborationPrivacyBudgetTemplatesPaginator
- ListCollaborationPrivacyBudgetsPaginator
- ListCollaborationsPaginator
- ListConfiguredAudienceModelAssociationsPaginator
- ListConfiguredTableAssociationsPaginator
- ListConfiguredTablesPaginator
- ListMembersPaginator
- ListMembershipsPaginator
- ListPrivacyBudgetTemplatesPaginator
- ListPrivacyBudgetsPaginator
- ListProtectedQueriesPaginator
- ListSchemasPaginator
Literals#
Type annotations for literals used in methods and schema.
# AggregateFunctionNameType usage example
from mypy_boto3_cleanrooms.literals import AggregateFunctionNameType
def get_value() -> AggregateFunctionNameType:
return "AVG"
- AggregateFunctionNameType
- AggregationTypeType
- AnalysisFormatType
- AnalysisMethodType
- AnalysisRuleTypeType
- CollaborationQueryLogStatusType
- ConfiguredTableAnalysisRuleTypeType
- DifferentialPrivacyAggregationTypeType
- FilterableMemberStatusType
- JoinOperatorType
- JoinRequiredOptionType
- ListAnalysisTemplatesPaginatorName
- ListCollaborationAnalysisTemplatesPaginatorName
- ListCollaborationConfiguredAudienceModelAssociationsPaginatorName
- ListCollaborationPrivacyBudgetTemplatesPaginatorName
- ListCollaborationPrivacyBudgetsPaginatorName
- ListCollaborationsPaginatorName
- ListConfiguredAudienceModelAssociationsPaginatorName
- ListConfiguredTableAssociationsPaginatorName
- ListConfiguredTablesPaginatorName
- ListMembersPaginatorName
- ListMembershipsPaginatorName
- ListPrivacyBudgetTemplatesPaginatorName
- ListPrivacyBudgetsPaginatorName
- ListProtectedQueriesPaginatorName
- ListSchemasPaginatorName
- MemberAbilityType
- MemberStatusType
- MembershipQueryLogStatusType
- MembershipStatusType
- ParameterTypeType
- PrivacyBudgetTemplateAutoRefreshType
- PrivacyBudgetTypeType
- ProtectedQueryStatusType
- ProtectedQueryTypeType
- ResultFormatType
- ScalarFunctionsType
- SchemaTypeType
- TargetProtectedQueryStatusType
- CleanRoomsServiceServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
- RegionName
Type definitions#
Type annotations for type definitions used in methods and schema.
- AggregateColumnTypeDef
- AggregationConstraintTypeDef
- AnalysisParameterTypeDef
- AnalysisRuleListTypeDef
- AnalysisSchemaTypeDef
- AnalysisSourceTypeDef
- AnalysisTemplateSummaryTypeDef
- BatchGetCollaborationAnalysisTemplateErrorTypeDef
- BatchGetCollaborationAnalysisTemplateInputRequestTypeDef
- ResponseMetadataTypeDef
- BatchGetSchemaErrorTypeDef
- BatchGetSchemaInputRequestTypeDef
- CollaborationAnalysisTemplateSummaryTypeDef
- CollaborationConfiguredAudienceModelAssociationSummaryTypeDef
- CollaborationConfiguredAudienceModelAssociationTypeDef
- CollaborationPrivacyBudgetTemplateSummaryTypeDef
- CollaborationSummaryTypeDef
- DataEncryptionMetadataTypeDef
- ColumnTypeDef
- ConfiguredAudienceModelAssociationSummaryTypeDef
- ConfiguredAudienceModelAssociationTypeDef
- ConfiguredTableAssociationSummaryTypeDef
- ConfiguredTableAssociationTypeDef
- ConfiguredTableSummaryTypeDef
- CreateConfiguredAudienceModelAssociationInputRequestTypeDef
- CreateConfiguredTableAssociationInputRequestTypeDef
- DeleteAnalysisTemplateInputRequestTypeDef
- DeleteCollaborationInputRequestTypeDef
- DeleteConfiguredAudienceModelAssociationInputRequestTypeDef
- DeleteConfiguredTableAnalysisRuleInputRequestTypeDef
- DeleteConfiguredTableAssociationInputRequestTypeDef
- DeleteConfiguredTableInputRequestTypeDef
- DeleteMemberInputRequestTypeDef
- DeleteMembershipInputRequestTypeDef
- DeletePrivacyBudgetTemplateInputRequestTypeDef
- DifferentialPrivacyColumnTypeDef
- DifferentialPrivacySensitivityParametersTypeDef
- DifferentialPrivacyPreviewAggregationTypeDef
- DifferentialPrivacyPreviewParametersInputTypeDef
- DifferentialPrivacyPrivacyBudgetAggregationTypeDef
- DifferentialPrivacyTemplateParametersInputTypeDef
- DifferentialPrivacyTemplateParametersOutputTypeDef
- DifferentialPrivacyTemplateUpdateParametersTypeDef
- GetAnalysisTemplateInputRequestTypeDef
- GetCollaborationAnalysisTemplateInputRequestTypeDef
- GetCollaborationConfiguredAudienceModelAssociationInputRequestTypeDef
- GetCollaborationInputRequestTypeDef
- GetCollaborationPrivacyBudgetTemplateInputRequestTypeDef
- GetConfiguredAudienceModelAssociationInputRequestTypeDef
- GetConfiguredTableAnalysisRuleInputRequestTypeDef
- GetConfiguredTableAssociationInputRequestTypeDef
- GetConfiguredTableInputRequestTypeDef
- GetMembershipInputRequestTypeDef
- GetPrivacyBudgetTemplateInputRequestTypeDef
- GetProtectedQueryInputRequestTypeDef
- GetSchemaAnalysisRuleInputRequestTypeDef
- GetSchemaInputRequestTypeDef
- GlueTableReferenceTypeDef
- PaginatorConfigTypeDef
- ListAnalysisTemplatesInputRequestTypeDef
- ListCollaborationAnalysisTemplatesInputRequestTypeDef
- ListCollaborationConfiguredAudienceModelAssociationsInputRequestTypeDef
- ListCollaborationPrivacyBudgetTemplatesInputRequestTypeDef
- ListCollaborationPrivacyBudgetsInputRequestTypeDef
- ListCollaborationsInputRequestTypeDef
- ListConfiguredAudienceModelAssociationsInputRequestTypeDef
- ListConfiguredTableAssociationsInputRequestTypeDef
- ListConfiguredTablesInputRequestTypeDef
- ListMembersInputRequestTypeDef
- ListMembershipsInputRequestTypeDef
- ListPrivacyBudgetTemplatesInputRequestTypeDef
- PrivacyBudgetTemplateSummaryTypeDef
- ListPrivacyBudgetsInputRequestTypeDef
- ListProtectedQueriesInputRequestTypeDef
- ProtectedQuerySummaryTypeDef
- ListSchemasInputRequestTypeDef
- SchemaSummaryTypeDef
- ListTagsForResourceInputRequestTypeDef
- MembershipQueryComputePaymentConfigTypeDef
- ProtectedQueryS3OutputConfigurationTypeDef
- QueryComputePaymentConfigTypeDef
- ProtectedQueryErrorTypeDef
- ProtectedQueryS3OutputTypeDef
- ProtectedQuerySingleMemberOutputTypeDef
- ProtectedQuerySQLParametersTypeDef
- ProtectedQueryStatisticsTypeDef
- TagResourceInputRequestTypeDef
- UntagResourceInputRequestTypeDef
- UpdateAnalysisTemplateInputRequestTypeDef
- UpdateCollaborationInputRequestTypeDef
- UpdateConfiguredAudienceModelAssociationInputRequestTypeDef
- UpdateConfiguredTableAssociationInputRequestTypeDef
- UpdateConfiguredTableInputRequestTypeDef
- UpdateProtectedQueryInputRequestTypeDef
- AnalysisRuleAggregationTypeDef
- AnalysisTemplateTypeDef
- CollaborationAnalysisTemplateTypeDef
- CreateAnalysisTemplateInputRequestTypeDef
- ListAnalysisTemplatesOutputTypeDef
- ListTagsForResourceOutputTypeDef
- ListCollaborationAnalysisTemplatesOutputTypeDef
- ListCollaborationConfiguredAudienceModelAssociationsOutputTypeDef
- GetCollaborationConfiguredAudienceModelAssociationOutputTypeDef
- ListCollaborationPrivacyBudgetTemplatesOutputTypeDef
- ListCollaborationsOutputTypeDef
- CollaborationTypeDef
- SchemaTypeDef
- ListConfiguredAudienceModelAssociationsOutputTypeDef
- CreateConfiguredAudienceModelAssociationOutputTypeDef
- GetConfiguredAudienceModelAssociationOutputTypeDef
- UpdateConfiguredAudienceModelAssociationOutputTypeDef
- ListConfiguredTableAssociationsOutputTypeDef
- CreateConfiguredTableAssociationOutputTypeDef
- GetConfiguredTableAssociationOutputTypeDef
- UpdateConfiguredTableAssociationOutputTypeDef
- ListConfiguredTablesOutputTypeDef
- DifferentialPrivacyConfigurationTypeDef
- DifferentialPrivacyParametersTypeDef
- DifferentialPrivacyPrivacyImpactTypeDef
- PreviewPrivacyImpactParametersInputTypeDef
- DifferentialPrivacyPrivacyBudgetTypeDef
- PrivacyBudgetTemplateParametersInputTypeDef
- PrivacyBudgetTemplateParametersOutputTypeDef
- PrivacyBudgetTemplateUpdateParametersTypeDef
- TableReferenceTypeDef
- ListAnalysisTemplatesInputListAnalysisTemplatesPaginateTypeDef
- ListCollaborationAnalysisTemplatesInputListCollaborationAnalysisTemplatesPaginateTypeDef
- ListCollaborationConfiguredAudienceModelAssociationsInputListCollaborationConfiguredAudienceModelAssociationsPaginateTypeDef
- ListCollaborationPrivacyBudgetTemplatesInputListCollaborationPrivacyBudgetTemplatesPaginateTypeDef
- ListCollaborationPrivacyBudgetsInputListCollaborationPrivacyBudgetsPaginateTypeDef
- ListCollaborationsInputListCollaborationsPaginateTypeDef
- ListConfiguredAudienceModelAssociationsInputListConfiguredAudienceModelAssociationsPaginateTypeDef
- ListConfiguredTableAssociationsInputListConfiguredTableAssociationsPaginateTypeDef
- ListConfiguredTablesInputListConfiguredTablesPaginateTypeDef
- ListMembersInputListMembersPaginateTypeDef
- ListMembershipsInputListMembershipsPaginateTypeDef
- ListPrivacyBudgetTemplatesInputListPrivacyBudgetTemplatesPaginateTypeDef
- ListPrivacyBudgetsInputListPrivacyBudgetsPaginateTypeDef
- ListProtectedQueriesInputListProtectedQueriesPaginateTypeDef
- ListSchemasInputListSchemasPaginateTypeDef
- ListPrivacyBudgetTemplatesOutputTypeDef
- ListProtectedQueriesOutputTypeDef
- ListSchemasOutputTypeDef
- MembershipPaymentConfigurationTypeDef
- MembershipProtectedQueryOutputConfigurationTypeDef
- ProtectedQueryOutputConfigurationTypeDef
- PaymentConfigurationTypeDef
- ProtectedQueryOutputTypeDef
- CreateAnalysisTemplateOutputTypeDef
- GetAnalysisTemplateOutputTypeDef
- UpdateAnalysisTemplateOutputTypeDef
- BatchGetCollaborationAnalysisTemplateOutputTypeDef
- GetCollaborationAnalysisTemplateOutputTypeDef
- CreateCollaborationOutputTypeDef
- GetCollaborationOutputTypeDef
- UpdateCollaborationOutputTypeDef
- BatchGetSchemaOutputTypeDef
- GetSchemaOutputTypeDef
- AnalysisRuleCustomTypeDef
- PrivacyImpactTypeDef
- PreviewPrivacyImpactInputRequestTypeDef
- PrivacyBudgetTypeDef
- CreatePrivacyBudgetTemplateInputRequestTypeDef
- CollaborationPrivacyBudgetTemplateTypeDef
- PrivacyBudgetTemplateTypeDef
- UpdatePrivacyBudgetTemplateInputRequestTypeDef
- ConfiguredTableTypeDef
- CreateConfiguredTableInputRequestTypeDef
- MembershipSummaryTypeDef
- MembershipProtectedQueryResultConfigurationTypeDef
- ProtectedQueryResultConfigurationTypeDef
- MemberSpecificationTypeDef
- MemberSummaryTypeDef
- ProtectedQueryResultTypeDef
- AnalysisRulePolicyV1TypeDef
- ConfiguredTableAnalysisRulePolicyV1TypeDef
- PreviewPrivacyImpactOutputTypeDef
- CollaborationPrivacyBudgetSummaryTypeDef
- PrivacyBudgetSummaryTypeDef
- GetCollaborationPrivacyBudgetTemplateOutputTypeDef
- CreatePrivacyBudgetTemplateOutputTypeDef
- GetPrivacyBudgetTemplateOutputTypeDef
- UpdatePrivacyBudgetTemplateOutputTypeDef
- CreateConfiguredTableOutputTypeDef
- GetConfiguredTableOutputTypeDef
- UpdateConfiguredTableOutputTypeDef
- ListMembershipsOutputTypeDef
- CreateMembershipInputRequestTypeDef
- MembershipTypeDef
- UpdateMembershipInputRequestTypeDef
- StartProtectedQueryInputRequestTypeDef
- CreateCollaborationInputRequestTypeDef
- ListMembersOutputTypeDef
- ProtectedQueryTypeDef
- AnalysisRulePolicyTypeDef
- ConfiguredTableAnalysisRulePolicyTypeDef
- ListCollaborationPrivacyBudgetsOutputTypeDef
- ListPrivacyBudgetsOutputTypeDef
- CreateMembershipOutputTypeDef
- GetMembershipOutputTypeDef
- UpdateMembershipOutputTypeDef
- GetProtectedQueryOutputTypeDef
- StartProtectedQueryOutputTypeDef
- UpdateProtectedQueryOutputTypeDef
- AnalysisRuleTypeDef
- ConfiguredTableAnalysisRuleTypeDef
- CreateConfiguredTableAnalysisRuleInputRequestTypeDef
- UpdateConfiguredTableAnalysisRuleInputRequestTypeDef
- GetSchemaAnalysisRuleOutputTypeDef
- CreateConfiguredTableAnalysisRuleOutputTypeDef
- GetConfiguredTableAnalysisRuleOutputTypeDef
- UpdateConfiguredTableAnalysisRuleOutputTypeDef