Skip to content

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.