CleanRoomsMLClient

Index > CleanRoomsML > CleanRoomsMLClient

Auto-generated documentation for CleanRoomsML type annotations stubs module mypy-boto3-cleanroomsml.

CleanRoomsMLClient

Type annotations and code completion for boto3.client("cleanroomsml"). boto3 documentation

# CleanRoomsMLClient usage example

from boto3.session import Session
from mypy_boto3_cleanroomsml.client import CleanRoomsMLClient

def get_cleanroomsml_client() -> CleanRoomsMLClient:
    return Session().client("cleanroomsml")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("cleanroomsml").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("cleanroomsml")

try:
    do_something(client)
except (
    client.exceptions.AccessDeniedException,
    client.exceptions.ClientError,
    client.exceptions.ConflictException,
    client.exceptions.ResourceNotFoundException,
    client.exceptions.ServiceQuotaExceededException,
    client.exceptions.ValidationException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_cleanroomsml.client import Exceptions

def handle_error(exc: Exceptions.AccessDeniedException) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("cleanroomsml").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("cleanroomsml").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

create_audience_model

Defines the information necessary to create an audience model.

Type annotations and code completion for boto3.client("cleanroomsml").create_audience_model method. boto3 documentation

# create_audience_model method definition

def create_audience_model(
    self,
    *,
    name: str,
    trainingDatasetArn: str,
    description: str = ...,
    kmsKeyArn: str = ...,
    tags: Mapping[str, str] = ...,
    trainingDataEndTime: Union[datetime, str] = ...,
    trainingDataStartTime: Union[datetime, str] = ...,
) -> CreateAudienceModelResponseTypeDef:  # (1)
    ...

1. See CreateAudienceModelResponseTypeDef

# create_audience_model method usage example with argument unpacking

kwargs: CreateAudienceModelRequestRequestTypeDef = {  # (1)
    "name": ...,
    "trainingDatasetArn": ...,
}

parent.create_audience_model(**kwargs)

1. See CreateAudienceModelRequestRequestTypeDef

create_configured_audience_model

Defines the information necessary to create a configured audience model.

Type annotations and code completion for boto3.client("cleanroomsml").create_configured_audience_model method. boto3 documentation

# create_configured_audience_model method definition

def create_configured_audience_model(
    self,
    *,
    audienceModelArn: str,
    name: str,
    outputConfig: ConfiguredAudienceModelOutputConfigTypeDef,  # (1)
    sharedAudienceMetrics: Sequence[SharedAudienceMetricsType],  # (2)
    audienceSizeConfig: Union[AudienceSizeConfigTypeDef, AudienceSizeConfigOutputTypeDef] = ...,  # (3)
    childResourceTagOnCreatePolicy: TagOnCreatePolicyType = ...,  # (4)
    description: str = ...,
    minMatchingSeedSize: int = ...,
    tags: Mapping[str, str] = ...,
) -> CreateConfiguredAudienceModelResponseTypeDef:  # (5)
    ...

1. See ConfiguredAudienceModelOutputConfigTypeDef
2. See SharedAudienceMetricsType
3. See AudienceSizeConfigTypeDef AudienceSizeConfigOutputTypeDef
4. See TagOnCreatePolicyType
5. See CreateConfiguredAudienceModelResponseTypeDef

# create_configured_audience_model method usage example with argument unpacking

kwargs: CreateConfiguredAudienceModelRequestRequestTypeDef = {  # (1)
    "audienceModelArn": ...,
    "name": ...,
    "outputConfig": ...,
    "sharedAudienceMetrics": ...,
}

parent.create_configured_audience_model(**kwargs)

1. See CreateConfiguredAudienceModelRequestRequestTypeDef

create_training_dataset

Defines the information necessary to create a training dataset.

Type annotations and code completion for boto3.client("cleanroomsml").create_training_dataset method. boto3 documentation

# create_training_dataset method definition

def create_training_dataset(
    self,
    *,
    name: str,
    roleArn: str,
    trainingData: Sequence[Union[DatasetTypeDef, DatasetOutputTypeDef]],  # (1)
    description: str = ...,
    tags: Mapping[str, str] = ...,
) -> CreateTrainingDatasetResponseTypeDef:  # (2)
    ...

1. See DatasetTypeDef DatasetOutputTypeDef
2. See CreateTrainingDatasetResponseTypeDef

# create_training_dataset method usage example with argument unpacking

kwargs: CreateTrainingDatasetRequestRequestTypeDef = {  # (1)
    "name": ...,
    "roleArn": ...,
    "trainingData": ...,
}

parent.create_training_dataset(**kwargs)

1. See CreateTrainingDatasetRequestRequestTypeDef

delete_audience_generation_job

Deletes the specified audience generation job, and removes all data associated with the job.

Type annotations and code completion for boto3.client("cleanroomsml").delete_audience_generation_job method. boto3 documentation

# delete_audience_generation_job method definition

def delete_audience_generation_job(
    self,
    *,
    audienceGenerationJobArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_audience_generation_job method usage example with argument unpacking

kwargs: DeleteAudienceGenerationJobRequestRequestTypeDef = {  # (1)
    "audienceGenerationJobArn": ...,
}

parent.delete_audience_generation_job(**kwargs)

1. See DeleteAudienceGenerationJobRequestRequestTypeDef

delete_audience_model

Specifies an audience model that you want to delete.

Type annotations and code completion for boto3.client("cleanroomsml").delete_audience_model method. boto3 documentation

# delete_audience_model method definition

def delete_audience_model(
    self,
    *,
    audienceModelArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_audience_model method usage example with argument unpacking

kwargs: DeleteAudienceModelRequestRequestTypeDef = {  # (1)
    "audienceModelArn": ...,
}

parent.delete_audience_model(**kwargs)

1. See DeleteAudienceModelRequestRequestTypeDef

delete_configured_audience_model

Deletes the specified configured audience model.

Type annotations and code completion for boto3.client("cleanroomsml").delete_configured_audience_model method. boto3 documentation

# delete_configured_audience_model method definition

def delete_configured_audience_model(
    self,
    *,
    configuredAudienceModelArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_configured_audience_model method usage example with argument unpacking

kwargs: DeleteConfiguredAudienceModelRequestRequestTypeDef = {  # (1)
    "configuredAudienceModelArn": ...,
}

parent.delete_configured_audience_model(**kwargs)

1. See DeleteConfiguredAudienceModelRequestRequestTypeDef

delete_configured_audience_model_policy

Deletes the specified configured audience model policy.

Type annotations and code completion for boto3.client("cleanroomsml").delete_configured_audience_model_policy method. boto3 documentation

# delete_configured_audience_model_policy method definition

def delete_configured_audience_model_policy(
    self,
    *,
    configuredAudienceModelArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_configured_audience_model_policy method usage example with argument unpacking

kwargs: DeleteConfiguredAudienceModelPolicyRequestRequestTypeDef = {  # (1)
    "configuredAudienceModelArn": ...,
}

parent.delete_configured_audience_model_policy(**kwargs)

1. See DeleteConfiguredAudienceModelPolicyRequestRequestTypeDef

delete_training_dataset

Specifies a training dataset that you want to delete.

Type annotations and code completion for boto3.client("cleanroomsml").delete_training_dataset method. boto3 documentation

# delete_training_dataset method definition

def delete_training_dataset(
    self,
    *,
    trainingDatasetArn: str,
) -> EmptyResponseMetadataTypeDef:  # (1)
    ...

1. See EmptyResponseMetadataTypeDef

# delete_training_dataset method usage example with argument unpacking

kwargs: DeleteTrainingDatasetRequestRequestTypeDef = {  # (1)
    "trainingDatasetArn": ...,
}

parent.delete_training_dataset(**kwargs)

1. See DeleteTrainingDatasetRequestRequestTypeDef

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("cleanroomsml").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_audience_generation_job

Returns information about an audience generation job.

Type annotations and code completion for boto3.client("cleanroomsml").get_audience_generation_job method. boto3 documentation

# get_audience_generation_job method definition

def get_audience_generation_job(
    self,
    *,
    audienceGenerationJobArn: str,
) -> GetAudienceGenerationJobResponseTypeDef:  # (1)
    ...

1. See GetAudienceGenerationJobResponseTypeDef

# get_audience_generation_job method usage example with argument unpacking

kwargs: GetAudienceGenerationJobRequestRequestTypeDef = {  # (1)
    "audienceGenerationJobArn": ...,
}

parent.get_audience_generation_job(**kwargs)

1. See GetAudienceGenerationJobRequestRequestTypeDef

get_audience_model

Returns information about an audience model See also: AWS API Documentation.

Type annotations and code completion for boto3.client("cleanroomsml").get_audience_model method. boto3 documentation

# get_audience_model method definition

def get_audience_model(
    self,
    *,
    audienceModelArn: str,
) -> GetAudienceModelResponseTypeDef:  # (1)
    ...

1. See GetAudienceModelResponseTypeDef

# get_audience_model method usage example with argument unpacking

kwargs: GetAudienceModelRequestRequestTypeDef = {  # (1)
    "audienceModelArn": ...,
}

parent.get_audience_model(**kwargs)

1. See GetAudienceModelRequestRequestTypeDef

get_configured_audience_model

Returns information about a specified configured audience model.

Type annotations and code completion for boto3.client("cleanroomsml").get_configured_audience_model method. boto3 documentation

# get_configured_audience_model method definition

def get_configured_audience_model(
    self,
    *,
    configuredAudienceModelArn: str,
) -> GetConfiguredAudienceModelResponseTypeDef:  # (1)
    ...

1. See GetConfiguredAudienceModelResponseTypeDef

# get_configured_audience_model method usage example with argument unpacking

kwargs: GetConfiguredAudienceModelRequestRequestTypeDef = {  # (1)
    "configuredAudienceModelArn": ...,
}

parent.get_configured_audience_model(**kwargs)

1. See GetConfiguredAudienceModelRequestRequestTypeDef

get_configured_audience_model_policy

Returns information about a configured audience model policy.

Type annotations and code completion for boto3.client("cleanroomsml").get_configured_audience_model_policy method. boto3 documentation

# get_configured_audience_model_policy method definition

def get_configured_audience_model_policy(
    self,
    *,
    configuredAudienceModelArn: str,
) -> GetConfiguredAudienceModelPolicyResponseTypeDef:  # (1)
    ...

1. See GetConfiguredAudienceModelPolicyResponseTypeDef

# get_configured_audience_model_policy method usage example with argument unpacking

kwargs: GetConfiguredAudienceModelPolicyRequestRequestTypeDef = {  # (1)
    "configuredAudienceModelArn": ...,
}

parent.get_configured_audience_model_policy(**kwargs)

1. See GetConfiguredAudienceModelPolicyRequestRequestTypeDef

get_training_dataset

Returns information about a training dataset.

Type annotations and code completion for boto3.client("cleanroomsml").get_training_dataset method. boto3 documentation

# get_training_dataset method definition

def get_training_dataset(
    self,
    *,
    trainingDatasetArn: str,
) -> GetTrainingDatasetResponseTypeDef:  # (1)
    ...

1. See GetTrainingDatasetResponseTypeDef

# get_training_dataset method usage example with argument unpacking

kwargs: GetTrainingDatasetRequestRequestTypeDef = {  # (1)
    "trainingDatasetArn": ...,
}

parent.get_training_dataset(**kwargs)

1. See GetTrainingDatasetRequestRequestTypeDef

list_audience_export_jobs

Returns a list of the audience export jobs.

Type annotations and code completion for boto3.client("cleanroomsml").list_audience_export_jobs method. boto3 documentation

# list_audience_export_jobs method definition

def list_audience_export_jobs(
    self,
    *,
    audienceGenerationJobArn: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAudienceExportJobsResponseTypeDef:  # (1)
    ...

1. See ListAudienceExportJobsResponseTypeDef

# list_audience_export_jobs method usage example with argument unpacking

kwargs: ListAudienceExportJobsRequestRequestTypeDef = {  # (1)
    "audienceGenerationJobArn": ...,
}

parent.list_audience_export_jobs(**kwargs)

1. See ListAudienceExportJobsRequestRequestTypeDef

list_audience_generation_jobs

Returns a list of audience generation jobs.

Type annotations and code completion for boto3.client("cleanroomsml").list_audience_generation_jobs method. boto3 documentation

# list_audience_generation_jobs method definition

def list_audience_generation_jobs(
    self,
    *,
    collaborationId: str = ...,
    configuredAudienceModelArn: str = ...,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAudienceGenerationJobsResponseTypeDef:  # (1)
    ...

1. See ListAudienceGenerationJobsResponseTypeDef

# list_audience_generation_jobs method usage example with argument unpacking

kwargs: ListAudienceGenerationJobsRequestRequestTypeDef = {  # (1)
    "collaborationId": ...,
}

parent.list_audience_generation_jobs(**kwargs)

1. See ListAudienceGenerationJobsRequestRequestTypeDef

list_audience_models

Returns a list of audience models.

Type annotations and code completion for boto3.client("cleanroomsml").list_audience_models method. boto3 documentation

# list_audience_models method definition

def list_audience_models(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListAudienceModelsResponseTypeDef:  # (1)
    ...

1. See ListAudienceModelsResponseTypeDef

# list_audience_models method usage example with argument unpacking

kwargs: ListAudienceModelsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_audience_models(**kwargs)

1. See ListAudienceModelsRequestRequestTypeDef

list_configured_audience_models

Returns a list of the configured audience models.

Type annotations and code completion for boto3.client("cleanroomsml").list_configured_audience_models method. boto3 documentation

# list_configured_audience_models method definition

def list_configured_audience_models(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListConfiguredAudienceModelsResponseTypeDef:  # (1)
    ...

1. See ListConfiguredAudienceModelsResponseTypeDef

# list_configured_audience_models method usage example with argument unpacking

kwargs: ListConfiguredAudienceModelsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_configured_audience_models(**kwargs)

1. See ListConfiguredAudienceModelsRequestRequestTypeDef

list_tags_for_resource

Returns a list of tags for a provided resource.

Type annotations and code completion for boto3.client("cleanroomsml").list_tags_for_resource method. boto3 documentation

# list_tags_for_resource method definition

def list_tags_for_resource(
    self,
    *,
    resourceArn: str,
) -> ListTagsForResourceResponseTypeDef:  # (1)
    ...

1. See ListTagsForResourceResponseTypeDef

# list_tags_for_resource method usage example with argument unpacking

kwargs: ListTagsForResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
}

parent.list_tags_for_resource(**kwargs)

1. See ListTagsForResourceRequestRequestTypeDef

list_training_datasets

Returns a list of training datasets.

Type annotations and code completion for boto3.client("cleanroomsml").list_training_datasets method. boto3 documentation

# list_training_datasets method definition

def list_training_datasets(
    self,
    *,
    maxResults: int = ...,
    nextToken: str = ...,
) -> ListTrainingDatasetsResponseTypeDef:  # (1)
    ...

1. See ListTrainingDatasetsResponseTypeDef

# list_training_datasets method usage example with argument unpacking

kwargs: ListTrainingDatasetsRequestRequestTypeDef = {  # (1)
    "maxResults": ...,
}

parent.list_training_datasets(**kwargs)

1. See ListTrainingDatasetsRequestRequestTypeDef

put_configured_audience_model_policy

Create or update the resource policy for a configured audience model.

Type annotations and code completion for boto3.client("cleanroomsml").put_configured_audience_model_policy method. boto3 documentation

# put_configured_audience_model_policy method definition

def put_configured_audience_model_policy(
    self,
    *,
    configuredAudienceModelArn: str,
    configuredAudienceModelPolicy: str,
    policyExistenceCondition: PolicyExistenceConditionType = ...,  # (1)
    previousPolicyHash: str = ...,
) -> PutConfiguredAudienceModelPolicyResponseTypeDef:  # (2)
    ...

1. See PolicyExistenceConditionType
2. See PutConfiguredAudienceModelPolicyResponseTypeDef

# put_configured_audience_model_policy method usage example with argument unpacking

kwargs: PutConfiguredAudienceModelPolicyRequestRequestTypeDef = {  # (1)
    "configuredAudienceModelArn": ...,
    "configuredAudienceModelPolicy": ...,
}

parent.put_configured_audience_model_policy(**kwargs)

1. See PutConfiguredAudienceModelPolicyRequestRequestTypeDef

start_audience_export_job

Export an audience of a specified size after you have generated an audience.

Type annotations and code completion for boto3.client("cleanroomsml").start_audience_export_job method. boto3 documentation

# start_audience_export_job method definition

def start_audience_export_job(
    self,
    *,
    audienceGenerationJobArn: str,
    audienceSize: AudienceSizeTypeDef,  # (1)
    name: str,
    description: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See AudienceSizeTypeDef
2. See EmptyResponseMetadataTypeDef

# start_audience_export_job method usage example with argument unpacking

kwargs: StartAudienceExportJobRequestRequestTypeDef = {  # (1)
    "audienceGenerationJobArn": ...,
    "audienceSize": ...,
    "name": ...,
}

parent.start_audience_export_job(**kwargs)

1. See StartAudienceExportJobRequestRequestTypeDef

start_audience_generation_job

Information necessary to start the audience generation job.

Type annotations and code completion for boto3.client("cleanroomsml").start_audience_generation_job method. boto3 documentation

# start_audience_generation_job method definition

def start_audience_generation_job(
    self,
    *,
    configuredAudienceModelArn: str,
    name: str,
    seedAudience: AudienceGenerationJobDataSourceTypeDef,  # (1)
    collaborationId: str = ...,
    description: str = ...,
    includeSeedInOutput: bool = ...,
    tags: Mapping[str, str] = ...,
) -> StartAudienceGenerationJobResponseTypeDef:  # (2)
    ...

1. See AudienceGenerationJobDataSourceTypeDef
2. See StartAudienceGenerationJobResponseTypeDef

# start_audience_generation_job method usage example with argument unpacking

kwargs: StartAudienceGenerationJobRequestRequestTypeDef = {  # (1)
    "configuredAudienceModelArn": ...,
    "name": ...,
    "seedAudience": ...,
}

parent.start_audience_generation_job(**kwargs)

1. See StartAudienceGenerationJobRequestRequestTypeDef

tag_resource

Adds metadata tags to a specified resource.

Type annotations and code completion for boto3.client("cleanroomsml").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: TagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tags": ...,
}

parent.tag_resource(**kwargs)

1. See TagResourceRequestRequestTypeDef

untag_resource

Removes metadata tags from a specified resource.

Type annotations and code completion for boto3.client("cleanroomsml").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: UntagResourceRequestRequestTypeDef = {  # (1)
    "resourceArn": ...,
    "tagKeys": ...,
}

parent.untag_resource(**kwargs)

1. See UntagResourceRequestRequestTypeDef

update_configured_audience_model

Provides the information necessary to update a configured audience model.

Type annotations and code completion for boto3.client("cleanroomsml").update_configured_audience_model method. boto3 documentation

# update_configured_audience_model method definition

def update_configured_audience_model(
    self,
    *,
    configuredAudienceModelArn: str,
    audienceModelArn: str = ...,
    audienceSizeConfig: Union[AudienceSizeConfigTypeDef, AudienceSizeConfigOutputTypeDef] = ...,  # (1)
    description: str = ...,
    minMatchingSeedSize: int = ...,
    outputConfig: ConfiguredAudienceModelOutputConfigTypeDef = ...,  # (2)
    sharedAudienceMetrics: Sequence[SharedAudienceMetricsType] = ...,  # (3)
) -> UpdateConfiguredAudienceModelResponseTypeDef:  # (4)
    ...

1. See AudienceSizeConfigTypeDef AudienceSizeConfigOutputTypeDef
2. See ConfiguredAudienceModelOutputConfigTypeDef
3. See SharedAudienceMetricsType
4. See UpdateConfiguredAudienceModelResponseTypeDef

# update_configured_audience_model method usage example with argument unpacking

kwargs: UpdateConfiguredAudienceModelRequestRequestTypeDef = {  # (1)
    "configuredAudienceModelArn": ...,
}

parent.update_configured_audience_model(**kwargs)

1. See UpdateConfiguredAudienceModelRequestRequestTypeDef

get_paginator

Type annotations and code completion for boto3.client("cleanroomsml").get_paginator method with overloads.

• client.get_paginator("list_audience_export_jobs") -> ListAudienceExportJobsPaginator
• client.get_paginator("list_audience_generation_jobs") -> ListAudienceGenerationJobsPaginator
• client.get_paginator("list_audience_models") -> ListAudienceModelsPaginator
• client.get_paginator("list_configured_audience_models") -> ListConfiguredAudienceModelsPaginator
• client.get_paginator("list_training_datasets") -> ListTrainingDatasetsPaginator