CleanRoomsML module#
Index > CleanRoomsML
Auto-generated documentation for CleanRoomsML type annotations stubs module types-boto3-cleanroomsml.
How to install#
Generate locally (recommended)#
You can generate type annotations for boto3
package locally with mypy-boto3-builder
.
Use uv for build isolation.
- Run mypy-boto3-builder in your package root directory:
uvx --with 'boto3==1.36.26' mypy-boto3-builder
- Select
boto3
AWS SDK. - Add
CleanRoomsML
service. - Use provided commands to install generated packages.
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 types-boto3
for CleanRoomsML
service.
# install with boto3 type annotations
python -m pip install 'types-boto3[cleanroomsml]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-boto3-lite[cleanroomsml]'
# standalone installation
python -m pip install types-boto3-cleanroomsml
How to uninstall#
python -m pip uninstall -y types-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 types_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 types_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
- ListCollaborationConfiguredModelAlgorithmAssociationsPaginator
- ListCollaborationMLInputChannelsPaginator
- ListCollaborationTrainedModelExportJobsPaginator
- ListCollaborationTrainedModelInferenceJobsPaginator
- ListCollaborationTrainedModelsPaginator
- ListConfiguredAudienceModelsPaginator
- ListConfiguredModelAlgorithmAssociationsPaginator
- ListConfiguredModelAlgorithmsPaginator
- ListMLInputChannelsPaginator
- ListTrainedModelInferenceJobsPaginator
- ListTrainedModelsPaginator
- ListTrainingDatasetsPaginator
Literals#
Type annotations for literals used in methods and schema.
# AudienceExportJobStatusType usage example
from types_boto3_cleanroomsml.literals import AudienceExportJobStatusType
def get_value() -> AudienceExportJobStatusType:
return "ACTIVE"
- AudienceExportJobStatusType
- AudienceGenerationJobStatusType
- AudienceModelStatusType
- AudienceSizeTypeType
- ColumnTypeType
- ConfiguredAudienceModelStatusType
- DatasetTypeType
- InferenceInstanceTypeType
- InstanceTypeType
- ListAudienceExportJobsPaginatorName
- ListAudienceGenerationJobsPaginatorName
- ListAudienceModelsPaginatorName
- ListCollaborationConfiguredModelAlgorithmAssociationsPaginatorName
- ListCollaborationMLInputChannelsPaginatorName
- ListCollaborationTrainedModelExportJobsPaginatorName
- ListCollaborationTrainedModelInferenceJobsPaginatorName
- ListCollaborationTrainedModelsPaginatorName
- ListConfiguredAudienceModelsPaginatorName
- ListConfiguredModelAlgorithmAssociationsPaginatorName
- ListConfiguredModelAlgorithmsPaginatorName
- ListMLInputChannelsPaginatorName
- ListTrainedModelInferenceJobsPaginatorName
- ListTrainedModelsPaginatorName
- ListTrainingDatasetsPaginatorName
- LogsStatusType
- MLInputChannelStatusType
- MetricsStatusType
- NoiseLevelTypeType
- PolicyExistenceConditionType
- SharedAudienceMetricsType
- TagOnCreatePolicyType
- TrainedModelExportFileTypeType
- TrainedModelExportJobStatusType
- TrainedModelExportsMaxSizeUnitTypeType
- TrainedModelInferenceJobStatusType
- TrainedModelInferenceMaxOutputSizeUnitTypeType
- TrainedModelStatusType
- TrainingDatasetStatusType
- WorkerComputeTypeType
- 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
- CancelTrainedModelInferenceJobRequestTypeDef
- CancelTrainedModelRequestTypeDef
- CollaborationConfiguredModelAlgorithmAssociationSummaryTypeDef
- CollaborationMLInputChannelSummaryTypeDef
- CollaborationTrainedModelSummaryTypeDef
- ColumnSchemaOutputTypeDef
- ColumnSchemaTypeDef
- WorkerComputeConfigurationTypeDef
- ConfiguredModelAlgorithmAssociationSummaryTypeDef
- ConfiguredModelAlgorithmSummaryTypeDef
- MetricDefinitionTypeDef
- TimestampTypeDef
- ResponseMetadataTypeDef
- InferenceContainerConfigTypeDef
- ModelTrainingDataChannelTypeDef
- ResourceConfigTypeDef
- StoppingConditionTypeDef
- GlueDataSourceTypeDef
- DeleteAudienceGenerationJobRequestTypeDef
- DeleteAudienceModelRequestTypeDef
- DeleteConfiguredAudienceModelPolicyRequestTypeDef
- DeleteConfiguredAudienceModelRequestTypeDef
- DeleteConfiguredModelAlgorithmAssociationRequestTypeDef
- DeleteConfiguredModelAlgorithmRequestTypeDef
- DeleteMLConfigurationRequestTypeDef
- DeleteMLInputChannelDataRequestTypeDef
- DeleteTrainedModelOutputRequestTypeDef
- DeleteTrainingDatasetRequestTypeDef
- GetAudienceGenerationJobRequestTypeDef
- GetAudienceModelRequestTypeDef
- GetCollaborationConfiguredModelAlgorithmAssociationRequestTypeDef
- GetCollaborationMLInputChannelRequestTypeDef
- GetCollaborationTrainedModelRequestTypeDef
- GetConfiguredAudienceModelPolicyRequestTypeDef
- GetConfiguredAudienceModelRequestTypeDef
- GetConfiguredModelAlgorithmAssociationRequestTypeDef
- GetConfiguredModelAlgorithmRequestTypeDef
- GetMLConfigurationRequestTypeDef
- GetMLInputChannelRequestTypeDef
- GetTrainedModelInferenceJobRequestTypeDef
- InferenceContainerExecutionParametersTypeDef
- InferenceResourceConfigTypeDef
- ModelInferenceDataSourceTypeDef
- GetTrainedModelRequestTypeDef
- GetTrainingDatasetRequestTypeDef
- InferenceReceiverMemberTypeDef
- PaginatorConfigTypeDef
- ListAudienceExportJobsRequestTypeDef
- ListAudienceGenerationJobsRequestTypeDef
- ListAudienceModelsRequestTypeDef
- ListCollaborationConfiguredModelAlgorithmAssociationsRequestTypeDef
- ListCollaborationMLInputChannelsRequestTypeDef
- ListCollaborationTrainedModelExportJobsRequestTypeDef
- ListCollaborationTrainedModelInferenceJobsRequestTypeDef
- ListCollaborationTrainedModelsRequestTypeDef
- ListConfiguredAudienceModelsRequestTypeDef
- ListConfiguredModelAlgorithmAssociationsRequestTypeDef
- ListConfiguredModelAlgorithmsRequestTypeDef
- ListMLInputChannelsRequestTypeDef
- MLInputChannelSummaryTypeDef
- ListTagsForResourceRequestTypeDef
- ListTrainedModelInferenceJobsRequestTypeDef
- ListTrainedModelsRequestTypeDef
- TrainedModelSummaryTypeDef
- ListTrainingDatasetsRequestTypeDef
- TrainingDatasetSummaryTypeDef
- LogsConfigurationPolicyOutputTypeDef
- LogsConfigurationPolicyTypeDef
- MetricsConfigurationPolicyTypeDef
- PutConfiguredAudienceModelPolicyRequestTypeDef
- TagResourceRequestTypeDef
- TrainedModelExportReceiverMemberTypeDef
- TrainedModelExportsMaxSizeTypeDef
- TrainedModelInferenceMaxOutputSizeTypeDef
- UntagResourceRequestTypeDef
- AudienceDestinationTypeDef
- DestinationTypeDef
- RelevanceMetricTypeDef
- StartAudienceExportJobRequestTypeDef
- AudienceExportJobSummaryTypeDef
- AudienceSizeConfigUnionTypeDef
- ColumnSchemaUnionTypeDef
- ComputeConfigurationTypeDef
- ContainerConfigOutputTypeDef
- ContainerConfigTypeDef
- CreateAudienceModelRequestTypeDef
- CreateAudienceModelResponseTypeDef
- CreateConfiguredAudienceModelResponseTypeDef
- CreateConfiguredModelAlgorithmAssociationResponseTypeDef
- CreateConfiguredModelAlgorithmResponseTypeDef
- CreateMLInputChannelResponseTypeDef
- CreateTrainedModelResponseTypeDef
- CreateTrainingDatasetResponseTypeDef
- EmptyResponseMetadataTypeDef
- GetAudienceModelResponseTypeDef
- GetCollaborationMLInputChannelResponseTypeDef
- GetConfiguredAudienceModelPolicyResponseTypeDef
- ListAudienceGenerationJobsResponseTypeDef
- ListAudienceModelsResponseTypeDef
- ListCollaborationConfiguredModelAlgorithmAssociationsResponseTypeDef
- ListCollaborationMLInputChannelsResponseTypeDef
- ListCollaborationTrainedModelsResponseTypeDef
- ListConfiguredModelAlgorithmAssociationsResponseTypeDef
- ListConfiguredModelAlgorithmsResponseTypeDef
- ListTagsForResourceResponseTypeDef
- PutConfiguredAudienceModelPolicyResponseTypeDef
- StartAudienceGenerationJobResponseTypeDef
- StartTrainedModelInferenceJobResponseTypeDef
- UpdateConfiguredAudienceModelResponseTypeDef
- CreateTrainedModelRequestTypeDef
- GetCollaborationTrainedModelResponseTypeDef
- GetTrainedModelResponseTypeDef
- DataSourceTypeDef
- InferenceOutputConfigurationOutputTypeDef
- InferenceOutputConfigurationTypeDef
- ListAudienceExportJobsRequestPaginateTypeDef
- ListAudienceGenerationJobsRequestPaginateTypeDef
- ListAudienceModelsRequestPaginateTypeDef
- ListCollaborationConfiguredModelAlgorithmAssociationsRequestPaginateTypeDef
- ListCollaborationMLInputChannelsRequestPaginateTypeDef
- ListCollaborationTrainedModelExportJobsRequestPaginateTypeDef
- ListCollaborationTrainedModelInferenceJobsRequestPaginateTypeDef
- ListCollaborationTrainedModelsRequestPaginateTypeDef
- ListConfiguredAudienceModelsRequestPaginateTypeDef
- ListConfiguredModelAlgorithmAssociationsRequestPaginateTypeDef
- ListConfiguredModelAlgorithmsRequestPaginateTypeDef
- ListMLInputChannelsRequestPaginateTypeDef
- ListTrainedModelInferenceJobsRequestPaginateTypeDef
- ListTrainedModelsRequestPaginateTypeDef
- ListTrainingDatasetsRequestPaginateTypeDef
- ListMLInputChannelsResponseTypeDef
- ListTrainedModelsResponseTypeDef
- ListTrainingDatasetsResponseTypeDef
- TrainedModelsConfigurationPolicyOutputTypeDef
- TrainedModelsConfigurationPolicyTypeDef
- TrainedModelExportOutputConfigurationOutputTypeDef
- TrainedModelExportOutputConfigurationTypeDef
- TrainedModelExportsConfigurationPolicyOutputTypeDef
- TrainedModelExportsConfigurationPolicyTypeDef
- TrainedModelInferenceJobsConfigurationPolicyOutputTypeDef
- TrainedModelInferenceJobsConfigurationPolicyTypeDef
- ConfiguredAudienceModelOutputConfigTypeDef
- MLOutputConfigurationTypeDef
- AudienceQualityMetricsTypeDef
- ListAudienceExportJobsResponseTypeDef
- AudienceGenerationJobDataSourceOutputTypeDef
- AudienceGenerationJobDataSourceTypeDef
- ProtectedQueryInputParametersOutputTypeDef
- ProtectedQueryInputParametersTypeDef
- GetConfiguredModelAlgorithmResponseTypeDef
- ContainerConfigUnionTypeDef
- DatasetInputConfigOutputTypeDef
- DatasetInputConfigTypeDef
- CollaborationTrainedModelInferenceJobSummaryTypeDef
- GetTrainedModelInferenceJobResponseTypeDef
- TrainedModelInferenceJobSummaryTypeDef
- InferenceOutputConfigurationUnionTypeDef
- CollaborationTrainedModelExportJobSummaryTypeDef
- TrainedModelExportOutputConfigurationUnionTypeDef
- PrivacyConfigurationPoliciesOutputTypeDef
- PrivacyConfigurationPoliciesTypeDef
- ConfiguredAudienceModelSummaryTypeDef
- CreateConfiguredAudienceModelRequestTypeDef
- GetConfiguredAudienceModelResponseTypeDef
- UpdateConfiguredAudienceModelRequestTypeDef
- GetMLConfigurationResponseTypeDef
- PutMLConfigurationRequestTypeDef
- GetAudienceGenerationJobResponseTypeDef
- AudienceGenerationJobDataSourceUnionTypeDef
- InputChannelDataSourceOutputTypeDef
- InputChannelDataSourceTypeDef
- CreateConfiguredModelAlgorithmRequestTypeDef
- DatasetOutputTypeDef
- DatasetInputConfigUnionTypeDef
- ListCollaborationTrainedModelInferenceJobsResponseTypeDef
- ListTrainedModelInferenceJobsResponseTypeDef
- StartTrainedModelInferenceJobRequestTypeDef
- ListCollaborationTrainedModelExportJobsResponseTypeDef
- StartTrainedModelExportJobRequestTypeDef
- PrivacyConfigurationOutputTypeDef
- PrivacyConfigurationTypeDef
- ListConfiguredAudienceModelsResponseTypeDef
- StartAudienceGenerationJobRequestTypeDef
- InputChannelOutputTypeDef
- InputChannelTypeDef
- GetTrainingDatasetResponseTypeDef
- DatasetTypeDef
- GetCollaborationConfiguredModelAlgorithmAssociationResponseTypeDef
- GetConfiguredModelAlgorithmAssociationResponseTypeDef
- PrivacyConfigurationUnionTypeDef
- GetMLInputChannelResponseTypeDef
- InputChannelUnionTypeDef
- DatasetUnionTypeDef
- CreateConfiguredModelAlgorithmAssociationRequestTypeDef
- CreateMLInputChannelRequestTypeDef
- CreateTrainingDatasetRequestTypeDef