CleanRoomsML module#
Index > CleanRoomsML
Auto-generated documentation for CleanRoomsML type annotations stubs module mypy-boto3-cleanroomsml.
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 CleanRoomsML
.
From PyPI with pip#
Install boto3-stubs
for CleanRoomsML
service.
# install with boto3 type annotations
python -m pip install 'boto3-stubs[cleanroomsml]'
# 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[cleanroomsml]'
# standalone installation
python -m pip install mypy-boto3-cleanroomsml
How to uninstall#
python -m pip uninstall -y mypy-boto3-cleanroomsml
Usage#
Code samples can be found in Examples.
CleanRoomsMLClient#
Type annotations and code completion for boto3.client("cleanroomsml")
as CleanRoomsMLClient
boto3 documentation
# CleanRoomsMLClient usage example
from boto3.session import Session
from mypy_boto3_cleanroomsml.client import CleanRoomsMLClient
def get_client() -> CleanRoomsMLClient:
return Session().client("cleanroomsml")
Paginators#
Type annotations and code completion for paginators
from boto3.client("cleanroomsml").get_paginator("...")
.
# ListAudienceExportJobsPaginator usage example
from boto3.session import Session
from mypy_boto3_cleanroomsml.paginator import ListAudienceExportJobsPaginator
def get_list_audience_export_jobs_paginator() -> ListAudienceExportJobsPaginator:
return Session().client("cleanroomsml").get_paginator("list_audience_export_jobs"))
- ListAudienceExportJobsPaginator
- ListAudienceGenerationJobsPaginator
- ListAudienceModelsPaginator
- ListConfiguredAudienceModelsPaginator
- ListTrainingDatasetsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AudienceExportJobStatusType usage example
from mypy_boto3_cleanroomsml.literals import AudienceExportJobStatusType
def get_value() -> AudienceExportJobStatusType:
return "ACTIVE"
- AudienceExportJobStatusType
- AudienceGenerationJobStatusType
- AudienceModelStatusType
- AudienceSizeTypeType
- ColumnTypeType
- ConfiguredAudienceModelStatusType
- DatasetTypeType
- ListAudienceExportJobsPaginatorName
- ListAudienceGenerationJobsPaginatorName
- ListAudienceModelsPaginatorName
- ListConfiguredAudienceModelsPaginatorName
- ListTrainingDatasetsPaginatorName
- PolicyExistenceConditionType
- SharedAudienceMetricsType
- TagOnCreatePolicyType
- TrainingDatasetStatusType
- CleanRoomsMLServiceName
- ServiceName
- ResourceServiceName
- PaginatorName
Type definitions#
Type annotations for type definitions used in methods and schema.
- S3ConfigMapTypeDef
- AudienceSizeTypeDef
- StatusDetailsTypeDef
- ProtectedQuerySQLParametersOutputTypeDef
- ProtectedQuerySQLParametersTypeDef
- AudienceGenerationJobSummaryTypeDef
- AudienceModelSummaryTypeDef
- AudienceSizeConfigOutputTypeDef
- AudienceSizeConfigTypeDef
- ColumnSchemaOutputTypeDef
- ColumnSchemaTypeDef
- TimestampTypeDef
- ResponseMetadataTypeDef
- GlueDataSourceTypeDef
- DeleteAudienceGenerationJobRequestRequestTypeDef
- DeleteAudienceModelRequestRequestTypeDef
- DeleteConfiguredAudienceModelPolicyRequestRequestTypeDef
- DeleteConfiguredAudienceModelRequestRequestTypeDef
- DeleteTrainingDatasetRequestRequestTypeDef
- GetAudienceGenerationJobRequestRequestTypeDef
- GetAudienceModelRequestRequestTypeDef
- GetConfiguredAudienceModelPolicyRequestRequestTypeDef
- GetConfiguredAudienceModelRequestRequestTypeDef
- GetTrainingDatasetRequestRequestTypeDef
- PaginatorConfigTypeDef
- ListAudienceExportJobsRequestRequestTypeDef
- ListAudienceGenerationJobsRequestRequestTypeDef
- ListAudienceModelsRequestRequestTypeDef
- ListConfiguredAudienceModelsRequestRequestTypeDef
- ListTagsForResourceRequestRequestTypeDef
- ListTrainingDatasetsRequestRequestTypeDef
- TrainingDatasetSummaryTypeDef
- PutConfiguredAudienceModelPolicyRequestRequestTypeDef
- TagResourceRequestRequestTypeDef
- UntagResourceRequestRequestTypeDef
- AudienceDestinationTypeDef
- RelevanceMetricTypeDef
- StartAudienceExportJobRequestRequestTypeDef
- AudienceExportJobSummaryTypeDef
- AudienceGenerationJobDataSourceOutputTypeDef
- AudienceGenerationJobDataSourceTypeDef
- AudienceSizeConfigUnionTypeDef
- CreateAudienceModelRequestRequestTypeDef
- CreateAudienceModelResponseTypeDef
- CreateConfiguredAudienceModelResponseTypeDef
- CreateTrainingDatasetResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetAudienceModelResponseTypeDef
- GetConfiguredAudienceModelPolicyResponseTypeDef
- ListAudienceGenerationJobsResponseTypeDef
- ListAudienceModelsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutConfiguredAudienceModelPolicyResponseTypeDef
- StartAudienceGenerationJobResponseTypeDef
- UpdateConfiguredAudienceModelResponseTypeDef
- DataSourceTypeDef
- ListAudienceExportJobsRequestListAudienceExportJobsPaginateTypeDef
- ListAudienceGenerationJobsRequestListAudienceGenerationJobsPaginateTypeDef
- ListAudienceModelsRequestListAudienceModelsPaginateTypeDef
- ListConfiguredAudienceModelsRequestListConfiguredAudienceModelsPaginateTypeDef
- ListTrainingDatasetsRequestListTrainingDatasetsPaginateTypeDef
- ListTrainingDatasetsResponseTypeDef
- ConfiguredAudienceModelOutputConfigTypeDef
- AudienceQualityMetricsTypeDef
- ListAudienceExportJobsResponseTypeDef
- AudienceGenerationJobDataSourceUnionTypeDef
- StartAudienceGenerationJobRequestRequestTypeDef
- DatasetInputConfigOutputTypeDef
- DatasetInputConfigTypeDef
- ConfiguredAudienceModelSummaryTypeDef
- CreateConfiguredAudienceModelRequestRequestTypeDef
- GetConfiguredAudienceModelResponseTypeDef
- UpdateConfiguredAudienceModelRequestRequestTypeDef
- GetAudienceGenerationJobResponseTypeDef
- DatasetOutputTypeDef
- DatasetTypeDef
- ListConfiguredAudienceModelsResponseTypeDef
- GetTrainingDatasetResponseTypeDef
- DatasetUnionTypeDef
- CreateTrainingDatasetRequestRequestTypeDef