Interface CleanRoomsMlClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated("software.amazon.awssdk:codegen")
@ThreadSafe
public interface CleanRoomsMlClient
extends AwsClient

Service client for accessing AWS Clean Rooms ML. This can be created using the static builder() method.

Welcome to the Amazon Web Services Clean Rooms ML API Reference.

Amazon Web Services Clean Rooms ML provides a privacy-enhancing method for two parties to identify similar users in their data without the need to share their data with each other. The first party brings the training data to Clean Rooms so that they can create and configure an audience model (lookalike model) and associate it with a collaboration. The second party then brings their seed data to Clean Rooms and generates an audience (lookalike segment) that resembles the training data.

To learn more about Amazon Web Services Clean Rooms ML concepts, procedures, and best practices, see the Clean Rooms User Guide.

To learn more about SQL commands, functions, and conditions supported in Clean Rooms, see the Clean Rooms SQL Reference.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SERVICE_METADATA_ID	Value for looking up the service's metadata from the ServiceMetadataProvider.
static final String	SERVICE_NAME

Method Summary

Modifier and Type	Method	Description
static CleanRoomsMlClientBuilder	builder()	Create a builder that can be used to configure and create a CleanRoomsMlClient.
static CleanRoomsMlClient	create()	Create a CleanRoomsMlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateAudienceModelResponse	createAudienceModel(Consumer<CreateAudienceModelRequest.Builder> createAudienceModelRequest)	Defines the information necessary to create an audience model.
default CreateAudienceModelResponse	createAudienceModel(CreateAudienceModelRequest createAudienceModelRequest)	Defines the information necessary to create an audience model.
default CreateConfiguredAudienceModelResponse	createConfiguredAudienceModel(Consumer<CreateConfiguredAudienceModelRequest.Builder> createConfiguredAudienceModelRequest)	Defines the information necessary to create a configured audience model.
default CreateConfiguredAudienceModelResponse	createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest)	Defines the information necessary to create a configured audience model.
default CreateTrainingDatasetResponse	createTrainingDataset(Consumer<CreateTrainingDatasetRequest.Builder> createTrainingDatasetRequest)	Defines the information necessary to create a training dataset.
default CreateTrainingDatasetResponse	createTrainingDataset(CreateTrainingDatasetRequest createTrainingDatasetRequest)	Defines the information necessary to create a training dataset.
default DeleteAudienceGenerationJobResponse	deleteAudienceGenerationJob(Consumer<DeleteAudienceGenerationJobRequest.Builder> deleteAudienceGenerationJobRequest)	Deletes the specified audience generation job, and removes all data associated with the job.
default DeleteAudienceGenerationJobResponse	deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest)	Deletes the specified audience generation job, and removes all data associated with the job.
default DeleteAudienceModelResponse	deleteAudienceModel(Consumer<DeleteAudienceModelRequest.Builder> deleteAudienceModelRequest)	Specifies an audience model that you want to delete.
default DeleteAudienceModelResponse	deleteAudienceModel(DeleteAudienceModelRequest deleteAudienceModelRequest)	Specifies an audience model that you want to delete.
default DeleteConfiguredAudienceModelResponse	deleteConfiguredAudienceModel(Consumer<DeleteConfiguredAudienceModelRequest.Builder> deleteConfiguredAudienceModelRequest)	Deletes the specified configured audience model.
default DeleteConfiguredAudienceModelResponse	deleteConfiguredAudienceModel(DeleteConfiguredAudienceModelRequest deleteConfiguredAudienceModelRequest)	Deletes the specified configured audience model.
default DeleteConfiguredAudienceModelPolicyResponse	deleteConfiguredAudienceModelPolicy(Consumer<DeleteConfiguredAudienceModelPolicyRequest.Builder> deleteConfiguredAudienceModelPolicyRequest)	Deletes the specified configured audience model policy.
default DeleteConfiguredAudienceModelPolicyResponse	deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest)	Deletes the specified configured audience model policy.
default DeleteTrainingDatasetResponse	deleteTrainingDataset(Consumer<DeleteTrainingDatasetRequest.Builder> deleteTrainingDatasetRequest)	Specifies a training dataset that you want to delete.
default DeleteTrainingDatasetResponse	deleteTrainingDataset(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest)	Specifies a training dataset that you want to delete.
default GetAudienceGenerationJobResponse	getAudienceGenerationJob(Consumer<GetAudienceGenerationJobRequest.Builder> getAudienceGenerationJobRequest)	Returns information about an audience generation job.
default GetAudienceGenerationJobResponse	getAudienceGenerationJob(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest)	Returns information about an audience generation job.
default GetAudienceModelResponse	getAudienceModel(Consumer<GetAudienceModelRequest.Builder> getAudienceModelRequest)	Returns information about an audience model
default GetAudienceModelResponse	getAudienceModel(GetAudienceModelRequest getAudienceModelRequest)	Returns information about an audience model
default GetConfiguredAudienceModelResponse	getConfiguredAudienceModel(Consumer<GetConfiguredAudienceModelRequest.Builder> getConfiguredAudienceModelRequest)	Returns information about a specified configured audience model.
default GetConfiguredAudienceModelResponse	getConfiguredAudienceModel(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest)	Returns information about a specified configured audience model.
default GetConfiguredAudienceModelPolicyResponse	getConfiguredAudienceModelPolicy(Consumer<GetConfiguredAudienceModelPolicyRequest.Builder> getConfiguredAudienceModelPolicyRequest)	Returns information about a configured audience model policy.
default GetConfiguredAudienceModelPolicyResponse	getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest)	Returns information about a configured audience model policy.
default GetTrainingDatasetResponse	getTrainingDataset(Consumer<GetTrainingDatasetRequest.Builder> getTrainingDatasetRequest)	Returns information about a training dataset.
default GetTrainingDatasetResponse	getTrainingDataset(GetTrainingDatasetRequest getTrainingDatasetRequest)	Returns information about a training dataset.
default ListAudienceExportJobsResponse	listAudienceExportJobs(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest)	Returns a list of the audience export jobs.
default ListAudienceExportJobsResponse	listAudienceExportJobs(ListAudienceExportJobsRequest listAudienceExportJobsRequest)	Returns a list of the audience export jobs.
default ListAudienceExportJobsIterable	listAudienceExportJobsPaginator(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest)	This is a variant of listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation.
default ListAudienceExportJobsIterable	listAudienceExportJobsPaginator(ListAudienceExportJobsRequest listAudienceExportJobsRequest)	This is a variant of listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation.
default ListAudienceGenerationJobsResponse	listAudienceGenerationJobs(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest)	Returns a list of audience generation jobs.
default ListAudienceGenerationJobsResponse	listAudienceGenerationJobs(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)	Returns a list of audience generation jobs.
default ListAudienceGenerationJobsIterable	listAudienceGenerationJobsPaginator(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest)	This is a variant of listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation.
default ListAudienceGenerationJobsIterable	listAudienceGenerationJobsPaginator(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)	This is a variant of listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation.
default ListAudienceModelsResponse	listAudienceModels(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest)	Returns a list of audience models.
default ListAudienceModelsResponse	listAudienceModels(ListAudienceModelsRequest listAudienceModelsRequest)	Returns a list of audience models.
default ListAudienceModelsIterable	listAudienceModelsPaginator(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest)	This is a variant of listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation.
default ListAudienceModelsIterable	listAudienceModelsPaginator(ListAudienceModelsRequest listAudienceModelsRequest)	This is a variant of listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation.
default ListConfiguredAudienceModelsResponse	listConfiguredAudienceModels(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest)	Returns a list of the configured audience models.
default ListConfiguredAudienceModelsResponse	listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)	Returns a list of the configured audience models.
default ListConfiguredAudienceModelsIterable	listConfiguredAudienceModelsPaginator(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest)	This is a variant of listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation.
default ListConfiguredAudienceModelsIterable	listConfiguredAudienceModelsPaginator(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)	This is a variant of listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation.
default ListTagsForResourceResponse	listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)	Returns a list of tags for a provided resource.
default ListTagsForResourceResponse	listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)	Returns a list of tags for a provided resource.
default ListTrainingDatasetsResponse	listTrainingDatasets(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest)	Returns a list of training datasets.
default ListTrainingDatasetsResponse	listTrainingDatasets(ListTrainingDatasetsRequest listTrainingDatasetsRequest)	Returns a list of training datasets.
default ListTrainingDatasetsIterable	listTrainingDatasetsPaginator(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest)	This is a variant of listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation.
default ListTrainingDatasetsIterable	listTrainingDatasetsPaginator(ListTrainingDatasetsRequest listTrainingDatasetsRequest)	This is a variant of listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation.
default PutConfiguredAudienceModelPolicyResponse	putConfiguredAudienceModelPolicy(Consumer<PutConfiguredAudienceModelPolicyRequest.Builder> putConfiguredAudienceModelPolicyRequest)	Create or update the resource policy for a configured audience model.
default PutConfiguredAudienceModelPolicyResponse	putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest)	Create or update the resource policy for a configured audience model.
default CleanRoomsMlServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
static ServiceMetadata	serviceMetadata()
default StartAudienceExportJobResponse	startAudienceExportJob(Consumer<StartAudienceExportJobRequest.Builder> startAudienceExportJobRequest)	Export an audience of a specified size after you have generated an audience.
default StartAudienceExportJobResponse	startAudienceExportJob(StartAudienceExportJobRequest startAudienceExportJobRequest)	Export an audience of a specified size after you have generated an audience.
default StartAudienceGenerationJobResponse	startAudienceGenerationJob(Consumer<StartAudienceGenerationJobRequest.Builder> startAudienceGenerationJobRequest)	Information necessary to start the audience generation job.
default StartAudienceGenerationJobResponse	startAudienceGenerationJob(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest)	Information necessary to start the audience generation job.
default TagResourceResponse	tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)	Adds metadata tags to a specified resource.
default TagResourceResponse	tagResource(TagResourceRequest tagResourceRequest)	Adds metadata tags to a specified resource.
default UntagResourceResponse	untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)	Removes metadata tags from a specified resource.
default UntagResourceResponse	untagResource(UntagResourceRequest untagResourceRequest)	Removes metadata tags from a specified resource.
default UpdateConfiguredAudienceModelResponse	updateConfiguredAudienceModel(Consumer<UpdateConfiguredAudienceModelRequest.Builder> updateConfiguredAudienceModelRequest)	Provides the information necessary to update a configured audience model.
default UpdateConfiguredAudienceModelResponse	updateConfiguredAudienceModel(UpdateConfiguredAudienceModelRequest updateConfiguredAudienceModelRequest)	Provides the information necessary to update a configured audience model.

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Field Details

SERVICE_NAME

static final String SERVICE_NAME

See Also:

• Constant Field Values

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

• Constant Field Values

Method Details

createAudienceModel

default CreateAudienceModelResponse createAudienceModel(CreateAudienceModelRequest createAudienceModelRequest)
                                                 throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

Parameters:

createAudienceModelRequest -

Returns:

Result of the CreateAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

createAudienceModel

default CreateAudienceModelResponse createAudienceModel(Consumer<CreateAudienceModelRequest.Builder> createAudienceModelRequest)
                                                 throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Defines the information necessary to create an audience model. An audience model is a machine learning model that Clean Rooms ML trains to measure similarity between users. Clean Rooms ML manages training and storing the audience model. The audience model can be used in multiple calls to the StartAudienceGenerationJob API.

This is a convenience which creates an instance of the CreateAudienceModelRequest.Builder avoiding the need to create one manually via CreateAudienceModelRequest.builder()

Parameters:

createAudienceModelRequest - A Consumer that will call methods on CreateAudienceModelRequest.Builder to create a request.

Returns:

Result of the CreateAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

createConfiguredAudienceModel

default CreateConfiguredAudienceModelResponse createConfiguredAudienceModel(CreateConfiguredAudienceModelRequest createConfiguredAudienceModelRequest)
                                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Defines the information necessary to create a configured audience model.

Parameters:

createConfiguredAudienceModelRequest -

Returns:

Result of the CreateConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

createConfiguredAudienceModel

default CreateConfiguredAudienceModelResponse createConfiguredAudienceModel(Consumer<CreateConfiguredAudienceModelRequest.Builder> createConfiguredAudienceModelRequest)
                                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Defines the information necessary to create a configured audience model.

This is a convenience which creates an instance of the CreateConfiguredAudienceModelRequest.Builder avoiding the need to create one manually via CreateConfiguredAudienceModelRequest.builder()

Parameters:

createConfiguredAudienceModelRequest - A Consumer that will call methods on CreateConfiguredAudienceModelRequest.Builder to create a request.

Returns:

Result of the CreateConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

createTrainingDataset

default CreateTrainingDatasetResponse createTrainingDataset(CreateTrainingDatasetRequest createTrainingDatasetRequest)
                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

Parameters:

createTrainingDatasetRequest -

Returns:

Result of the CreateTrainingDataset operation returned by the service.

See Also:

• AWS API Documentation

createTrainingDataset

default CreateTrainingDatasetResponse createTrainingDataset(Consumer<CreateTrainingDatasetRequest.Builder> createTrainingDatasetRequest)
                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Defines the information necessary to create a training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation.

This is a convenience which creates an instance of the CreateTrainingDatasetRequest.Builder avoiding the need to create one manually via CreateTrainingDatasetRequest.builder()

Parameters:

createTrainingDatasetRequest - A Consumer that will call methods on CreateTrainingDatasetRequest.Builder to create a request.

Returns:

Result of the CreateTrainingDataset operation returned by the service.

See Also:

• AWS API Documentation

deleteAudienceGenerationJob

default DeleteAudienceGenerationJobResponse deleteAudienceGenerationJob(DeleteAudienceGenerationJobRequest deleteAudienceGenerationJobRequest)
                                                                 throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

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

Parameters:

deleteAudienceGenerationJobRequest -

Returns:

Result of the DeleteAudienceGenerationJob operation returned by the service.

See Also:

• AWS API Documentation

deleteAudienceGenerationJob

default DeleteAudienceGenerationJobResponse deleteAudienceGenerationJob(Consumer<DeleteAudienceGenerationJobRequest.Builder> deleteAudienceGenerationJobRequest)
                                                                 throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

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

This is a convenience which creates an instance of the DeleteAudienceGenerationJobRequest.Builder avoiding the need to create one manually via DeleteAudienceGenerationJobRequest.builder()

Parameters:

deleteAudienceGenerationJobRequest - A Consumer that will call methods on DeleteAudienceGenerationJobRequest.Builder to create a request.

Returns:

Result of the DeleteAudienceGenerationJob operation returned by the service.

See Also:

• AWS API Documentation

deleteAudienceModel

default DeleteAudienceModelResponse deleteAudienceModel(DeleteAudienceModelRequest deleteAudienceModelRequest)
                                                 throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.

Parameters:

deleteAudienceModelRequest -

Returns:

Result of the DeleteAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

deleteAudienceModel

default DeleteAudienceModelResponse deleteAudienceModel(Consumer<DeleteAudienceModelRequest.Builder> deleteAudienceModelRequest)
                                                 throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Specifies an audience model that you want to delete. You can't delete an audience model if there are any configured audience models that depend on the audience model.

This is a convenience which creates an instance of the DeleteAudienceModelRequest.Builder avoiding the need to create one manually via DeleteAudienceModelRequest.builder()

Parameters:

deleteAudienceModelRequest - A Consumer that will call methods on DeleteAudienceModelRequest.Builder to create a request.

Returns:

Result of the DeleteAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

deleteConfiguredAudienceModel

default DeleteConfiguredAudienceModelResponse deleteConfiguredAudienceModel(DeleteConfiguredAudienceModelRequest deleteConfiguredAudienceModelRequest)
                                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

Parameters:

deleteConfiguredAudienceModelRequest -

Returns:

Result of the DeleteConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

deleteConfiguredAudienceModel

default DeleteConfiguredAudienceModelResponse deleteConfiguredAudienceModel(Consumer<DeleteConfiguredAudienceModelRequest.Builder> deleteConfiguredAudienceModelRequest)
                                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Deletes the specified configured audience model. You can't delete a configured audience model if there are any lookalike models that use the configured audience model. If you delete a configured audience model, it will be removed from any collaborations that it is associated to.

This is a convenience which creates an instance of the DeleteConfiguredAudienceModelRequest.Builder avoiding the need to create one manually via DeleteConfiguredAudienceModelRequest.builder()

Parameters:

deleteConfiguredAudienceModelRequest - A Consumer that will call methods on DeleteConfiguredAudienceModelRequest.Builder to create a request.

Returns:

Result of the DeleteConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

deleteConfiguredAudienceModelPolicy

default DeleteConfiguredAudienceModelPolicyResponse deleteConfiguredAudienceModelPolicy(DeleteConfiguredAudienceModelPolicyRequest deleteConfiguredAudienceModelPolicyRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Deletes the specified configured audience model policy.

Parameters:

deleteConfiguredAudienceModelPolicyRequest -

Returns:

Result of the DeleteConfiguredAudienceModelPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteConfiguredAudienceModelPolicy

default DeleteConfiguredAudienceModelPolicyResponse deleteConfiguredAudienceModelPolicy(Consumer<DeleteConfiguredAudienceModelPolicyRequest.Builder> deleteConfiguredAudienceModelPolicyRequest)
                                                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Deletes the specified configured audience model policy.

This is a convenience which creates an instance of the DeleteConfiguredAudienceModelPolicyRequest.Builder avoiding the need to create one manually via DeleteConfiguredAudienceModelPolicyRequest.builder()

Parameters:

deleteConfiguredAudienceModelPolicyRequest - A Consumer that will call methods on DeleteConfiguredAudienceModelPolicyRequest.Builder to create a request.

Returns:

Result of the DeleteConfiguredAudienceModelPolicy operation returned by the service.

See Also:

• AWS API Documentation

deleteTrainingDataset

default DeleteTrainingDatasetResponse deleteTrainingDataset(DeleteTrainingDatasetRequest deleteTrainingDatasetRequest)
                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.

Parameters:

deleteTrainingDatasetRequest -

Returns:

Result of the DeleteTrainingDataset operation returned by the service.

See Also:

• AWS API Documentation

deleteTrainingDataset

default DeleteTrainingDatasetResponse deleteTrainingDataset(Consumer<DeleteTrainingDatasetRequest.Builder> deleteTrainingDatasetRequest)
                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Specifies a training dataset that you want to delete. You can't delete a training dataset if there are any audience models that depend on the training dataset. In Clean Rooms ML, the TrainingDataset is metadata that points to a Glue table, which is read only during AudienceModel creation. This action deletes the metadata.

This is a convenience which creates an instance of the DeleteTrainingDatasetRequest.Builder avoiding the need to create one manually via DeleteTrainingDatasetRequest.builder()

Parameters:

deleteTrainingDatasetRequest - A Consumer that will call methods on DeleteTrainingDatasetRequest.Builder to create a request.

Returns:

Result of the DeleteTrainingDataset operation returned by the service.

See Also:

• AWS API Documentation

getAudienceGenerationJob

default GetAudienceGenerationJobResponse getAudienceGenerationJob(GetAudienceGenerationJobRequest getAudienceGenerationJobRequest)
                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about an audience generation job.

Parameters:

getAudienceGenerationJobRequest -

Returns:

Result of the GetAudienceGenerationJob operation returned by the service.

See Also:

• AWS API Documentation

getAudienceGenerationJob

default GetAudienceGenerationJobResponse getAudienceGenerationJob(Consumer<GetAudienceGenerationJobRequest.Builder> getAudienceGenerationJobRequest)
                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about an audience generation job.

This is a convenience which creates an instance of the GetAudienceGenerationJobRequest.Builder avoiding the need to create one manually via GetAudienceGenerationJobRequest.builder()

Parameters:

getAudienceGenerationJobRequest - A Consumer that will call methods on GetAudienceGenerationJobRequest.Builder to create a request.

Returns:

Result of the GetAudienceGenerationJob operation returned by the service.

See Also:

• AWS API Documentation

getAudienceModel

default GetAudienceModelResponse getAudienceModel(GetAudienceModelRequest getAudienceModelRequest)
                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about an audience model

Parameters:

getAudienceModelRequest -

Returns:

Result of the GetAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

getAudienceModel

default GetAudienceModelResponse getAudienceModel(Consumer<GetAudienceModelRequest.Builder> getAudienceModelRequest)
                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about an audience model

This is a convenience which creates an instance of the GetAudienceModelRequest.Builder avoiding the need to create one manually via GetAudienceModelRequest.builder()

Parameters:

getAudienceModelRequest - A Consumer that will call methods on GetAudienceModelRequest.Builder to create a request.

Returns:

Result of the GetAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

getConfiguredAudienceModel

default GetConfiguredAudienceModelResponse getConfiguredAudienceModel(GetConfiguredAudienceModelRequest getConfiguredAudienceModelRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about a specified configured audience model.

Parameters:

getConfiguredAudienceModelRequest -

Returns:

Result of the GetConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

getConfiguredAudienceModel

default GetConfiguredAudienceModelResponse getConfiguredAudienceModel(Consumer<GetConfiguredAudienceModelRequest.Builder> getConfiguredAudienceModelRequest)
                                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about a specified configured audience model.

This is a convenience which creates an instance of the GetConfiguredAudienceModelRequest.Builder avoiding the need to create one manually via GetConfiguredAudienceModelRequest.builder()

Parameters:

getConfiguredAudienceModelRequest - A Consumer that will call methods on GetConfiguredAudienceModelRequest.Builder to create a request.

Returns:

Result of the GetConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

getConfiguredAudienceModelPolicy

default GetConfiguredAudienceModelPolicyResponse getConfiguredAudienceModelPolicy(GetConfiguredAudienceModelPolicyRequest getConfiguredAudienceModelPolicyRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about a configured audience model policy.

Parameters:

getConfiguredAudienceModelPolicyRequest -

Returns:

Result of the GetConfiguredAudienceModelPolicy operation returned by the service.

See Also:

• AWS API Documentation

getConfiguredAudienceModelPolicy

default GetConfiguredAudienceModelPolicyResponse getConfiguredAudienceModelPolicy(Consumer<GetConfiguredAudienceModelPolicyRequest.Builder> getConfiguredAudienceModelPolicyRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about a configured audience model policy.

This is a convenience which creates an instance of the GetConfiguredAudienceModelPolicyRequest.Builder avoiding the need to create one manually via GetConfiguredAudienceModelPolicyRequest.builder()

Parameters:

getConfiguredAudienceModelPolicyRequest - A Consumer that will call methods on GetConfiguredAudienceModelPolicyRequest.Builder to create a request.

Returns:

Result of the GetConfiguredAudienceModelPolicy operation returned by the service.

See Also:

• AWS API Documentation

getTrainingDataset

default GetTrainingDatasetResponse getTrainingDataset(GetTrainingDatasetRequest getTrainingDatasetRequest)
                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about a training dataset.

Parameters:

getTrainingDatasetRequest -

Returns:

Result of the GetTrainingDataset operation returned by the service.

See Also:

• AWS API Documentation

getTrainingDataset

default GetTrainingDatasetResponse getTrainingDataset(Consumer<GetTrainingDatasetRequest.Builder> getTrainingDatasetRequest)
                                               throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns information about a training dataset.

This is a convenience which creates an instance of the GetTrainingDatasetRequest.Builder avoiding the need to create one manually via GetTrainingDatasetRequest.builder()

Parameters:

getTrainingDatasetRequest - A Consumer that will call methods on GetTrainingDatasetRequest.Builder to create a request.

Returns:

Result of the GetTrainingDataset operation returned by the service.

See Also:

• AWS API Documentation

listAudienceExportJobs

default ListAudienceExportJobsResponse listAudienceExportJobs(ListAudienceExportJobsRequest listAudienceExportJobsRequest)
                                                       throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of the audience export jobs.

Parameters:

listAudienceExportJobsRequest -

Returns:

Result of the ListAudienceExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listAudienceExportJobs

default ListAudienceExportJobsResponse listAudienceExportJobs(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest)
                                                       throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of the audience export jobs.

This is a convenience which creates an instance of the ListAudienceExportJobsRequest.Builder avoiding the need to create one manually via ListAudienceExportJobsRequest.builder()

Parameters:

listAudienceExportJobsRequest - A Consumer that will call methods on ListAudienceExportJobsRequest.Builder to create a request.

Returns:

Result of the ListAudienceExportJobs operation returned by the service.

See Also:

• AWS API Documentation

listAudienceExportJobsPaginator

default ListAudienceExportJobsIterable listAudienceExportJobsPaginator(ListAudienceExportJobsRequest listAudienceExportJobsRequest)
                                                                throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsIterable responses = client.listAudienceExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsIterable responses = client
             .listAudienceExportJobsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsIterable responses = client.listAudienceExportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation.

Parameters:

listAudienceExportJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAudienceExportJobsPaginator

default ListAudienceExportJobsIterable listAudienceExportJobsPaginator(Consumer<ListAudienceExportJobsRequest.Builder> listAudienceExportJobsRequest)
                                                                throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsIterable responses = client.listAudienceExportJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsIterable responses = client
             .listAudienceExportJobsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceExportJobsIterable responses = client.listAudienceExportJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAudienceExportJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceExportJobsRequest) operation.

This is a convenience which creates an instance of the ListAudienceExportJobsRequest.Builder avoiding the need to create one manually via ListAudienceExportJobsRequest.builder()

Parameters:

listAudienceExportJobsRequest - A Consumer that will call methods on ListAudienceExportJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAudienceGenerationJobs

default ListAudienceGenerationJobsResponse listAudienceGenerationJobs(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)
                                                               throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of audience generation jobs.

Parameters:

listAudienceGenerationJobsRequest -

Returns:

Result of the ListAudienceGenerationJobs operation returned by the service.

See Also:

• AWS API Documentation

listAudienceGenerationJobs

default ListAudienceGenerationJobsResponse listAudienceGenerationJobs(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest)
                                                               throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of audience generation jobs.

This is a convenience which creates an instance of the ListAudienceGenerationJobsRequest.Builder avoiding the need to create one manually via ListAudienceGenerationJobsRequest.builder()

Parameters:

listAudienceGenerationJobsRequest - A Consumer that will call methods on ListAudienceGenerationJobsRequest.Builder to create a request.

Returns:

Result of the ListAudienceGenerationJobs operation returned by the service.

See Also:

• AWS API Documentation

listAudienceGenerationJobsPaginator

default ListAudienceGenerationJobsIterable listAudienceGenerationJobsPaginator(ListAudienceGenerationJobsRequest listAudienceGenerationJobsRequest)
                                                                        throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsIterable responses = client.listAudienceGenerationJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsIterable responses = client
             .listAudienceGenerationJobsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsIterable responses = client.listAudienceGenerationJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation.

Parameters:

listAudienceGenerationJobsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAudienceGenerationJobsPaginator

default ListAudienceGenerationJobsIterable listAudienceGenerationJobsPaginator(Consumer<ListAudienceGenerationJobsRequest.Builder> listAudienceGenerationJobsRequest)
                                                                        throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsIterable responses = client.listAudienceGenerationJobsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsIterable responses = client
             .listAudienceGenerationJobsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceGenerationJobsIterable responses = client.listAudienceGenerationJobsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAudienceGenerationJobs(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceGenerationJobsRequest) operation.

This is a convenience which creates an instance of the ListAudienceGenerationJobsRequest.Builder avoiding the need to create one manually via ListAudienceGenerationJobsRequest.builder()

Parameters:

listAudienceGenerationJobsRequest - A Consumer that will call methods on ListAudienceGenerationJobsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAudienceModels

default ListAudienceModelsResponse listAudienceModels(ListAudienceModelsRequest listAudienceModelsRequest)
                                               throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of audience models.

Parameters:

listAudienceModelsRequest -

Returns:

Result of the ListAudienceModels operation returned by the service.

See Also:

• AWS API Documentation

listAudienceModels

default ListAudienceModelsResponse listAudienceModels(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest)
                                               throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of audience models.

This is a convenience which creates an instance of the ListAudienceModelsRequest.Builder avoiding the need to create one manually via ListAudienceModelsRequest.builder()

Parameters:

listAudienceModelsRequest - A Consumer that will call methods on ListAudienceModelsRequest.Builder to create a request.

Returns:

Result of the ListAudienceModels operation returned by the service.

See Also:

• AWS API Documentation

listAudienceModelsPaginator

default ListAudienceModelsIterable listAudienceModelsPaginator(ListAudienceModelsRequest listAudienceModelsRequest)
                                                        throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsIterable responses = client.listAudienceModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsIterable responses = client
             .listAudienceModelsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsIterable responses = client.listAudienceModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation.

Parameters:

listAudienceModelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listAudienceModelsPaginator

default ListAudienceModelsIterable listAudienceModelsPaginator(Consumer<ListAudienceModelsRequest.Builder> listAudienceModelsRequest)
                                                        throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsIterable responses = client.listAudienceModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsIterable responses = client
             .listAudienceModelsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListAudienceModelsIterable responses = client.listAudienceModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListAudienceModelsRequest) operation.

This is a convenience which creates an instance of the ListAudienceModelsRequest.Builder avoiding the need to create one manually via ListAudienceModelsRequest.builder()

Parameters:

listAudienceModelsRequest - A Consumer that will call methods on ListAudienceModelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listConfiguredAudienceModels

default ListConfiguredAudienceModelsResponse listConfiguredAudienceModels(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)
                                                                   throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of the configured audience models.

Parameters:

listConfiguredAudienceModelsRequest -

Returns:

Result of the ListConfiguredAudienceModels operation returned by the service.

See Also:

• AWS API Documentation

listConfiguredAudienceModels

default ListConfiguredAudienceModelsResponse listConfiguredAudienceModels(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest)
                                                                   throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of the configured audience models.

This is a convenience which creates an instance of the ListConfiguredAudienceModelsRequest.Builder avoiding the need to create one manually via ListConfiguredAudienceModelsRequest.builder()

Parameters:

listConfiguredAudienceModelsRequest - A Consumer that will call methods on ListConfiguredAudienceModelsRequest.Builder to create a request.

Returns:

Result of the ListConfiguredAudienceModels operation returned by the service.

See Also:

• AWS API Documentation

listConfiguredAudienceModelsPaginator

default ListConfiguredAudienceModelsIterable listConfiguredAudienceModelsPaginator(ListConfiguredAudienceModelsRequest listConfiguredAudienceModelsRequest)
                                                                            throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsIterable responses = client.listConfiguredAudienceModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsIterable responses = client
             .listConfiguredAudienceModelsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsIterable responses = client.listConfiguredAudienceModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation.

Parameters:

listConfiguredAudienceModelsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listConfiguredAudienceModelsPaginator

default ListConfiguredAudienceModelsIterable listConfiguredAudienceModelsPaginator(Consumer<ListConfiguredAudienceModelsRequest.Builder> listConfiguredAudienceModelsRequest)
                                                                            throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsIterable responses = client.listConfiguredAudienceModelsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsIterable responses = client
             .listConfiguredAudienceModelsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListConfiguredAudienceModelsIterable responses = client.listConfiguredAudienceModelsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listConfiguredAudienceModels(software.amazon.awssdk.services.cleanroomsml.model.ListConfiguredAudienceModelsRequest) operation.

This is a convenience which creates an instance of the ListConfiguredAudienceModelsRequest.Builder avoiding the need to create one manually via ListConfiguredAudienceModelsRequest.builder()

Parameters:

listConfiguredAudienceModelsRequest - A Consumer that will call methods on ListConfiguredAudienceModelsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of tags for a provided resource.

Parameters:

listTagsForResourceRequest -

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTagsForResource

default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
                                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of tags for a provided resource.

This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the need to create one manually via ListTagsForResourceRequest.builder()

Parameters:

listTagsForResourceRequest - A Consumer that will call methods on ListTagsForResourceRequest.Builder to create a request.

Returns:

Result of the ListTagsForResource operation returned by the service.

See Also:

• AWS API Documentation

listTrainingDatasets

default ListTrainingDatasetsResponse listTrainingDatasets(ListTrainingDatasetsRequest listTrainingDatasetsRequest)
                                                   throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of training datasets.

Parameters:

listTrainingDatasetsRequest -

Returns:

Result of the ListTrainingDatasets operation returned by the service.

See Also:

• AWS API Documentation

listTrainingDatasets

default ListTrainingDatasetsResponse listTrainingDatasets(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest)
                                                   throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Returns a list of training datasets.

This is a convenience which creates an instance of the ListTrainingDatasetsRequest.Builder avoiding the need to create one manually via ListTrainingDatasetsRequest.builder()

Parameters:

listTrainingDatasetsRequest - A Consumer that will call methods on ListTrainingDatasetsRequest.Builder to create a request.

Returns:

Result of the ListTrainingDatasets operation returned by the service.

See Also:

• AWS API Documentation

listTrainingDatasetsPaginator

default ListTrainingDatasetsIterable listTrainingDatasetsPaginator(ListTrainingDatasetsRequest listTrainingDatasetsRequest)
                                                            throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsIterable responses = client.listTrainingDatasetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsIterable responses = client
             .listTrainingDatasetsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsIterable responses = client.listTrainingDatasetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation.

Parameters:

listTrainingDatasetsRequest -

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

listTrainingDatasetsPaginator

default ListTrainingDatasetsIterable listTrainingDatasetsPaginator(Consumer<ListTrainingDatasetsRequest.Builder> listTrainingDatasetsRequest)
                                                            throws ValidationException,
AccessDeniedException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

This is a variant of listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.

When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.

The following are few ways to iterate through the response pages:

1) Using a Stream

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsIterable responses = client.listTrainingDatasetsPaginator(request);
 responses.stream().forEach(....);
 
 

2) Using For loop

 {
     @code
     software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsIterable responses = client
             .listTrainingDatasetsPaginator(request);
     for (software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsResponse response : responses) {
         // do something;
     }
 }
 

3) Use iterator directly

 
 software.amazon.awssdk.services.cleanroomsml.paginators.ListTrainingDatasetsIterable responses = client.listTrainingDatasetsPaginator(request);
 responses.iterator().forEachRemaining(....);
 
 

Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.

Note: If you prefer to have control on service calls, use the listTrainingDatasets(software.amazon.awssdk.services.cleanroomsml.model.ListTrainingDatasetsRequest) operation.

This is a convenience which creates an instance of the ListTrainingDatasetsRequest.Builder avoiding the need to create one manually via ListTrainingDatasetsRequest.builder()

Parameters:

listTrainingDatasetsRequest - A Consumer that will call methods on ListTrainingDatasetsRequest.Builder to create a request.

Returns:

A custom iterable that can be used to iterate through all the response pages.

See Also:

• AWS API Documentation

putConfiguredAudienceModelPolicy

default PutConfiguredAudienceModelPolicyResponse putConfiguredAudienceModelPolicy(PutConfiguredAudienceModelPolicyRequest putConfiguredAudienceModelPolicyRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

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

Parameters:

putConfiguredAudienceModelPolicyRequest -

Returns:

Result of the PutConfiguredAudienceModelPolicy operation returned by the service.

See Also:

• AWS API Documentation

putConfiguredAudienceModelPolicy

default PutConfiguredAudienceModelPolicyResponse putConfiguredAudienceModelPolicy(Consumer<PutConfiguredAudienceModelPolicyRequest.Builder> putConfiguredAudienceModelPolicyRequest)
                                                                           throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

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

This is a convenience which creates an instance of the PutConfiguredAudienceModelPolicyRequest.Builder avoiding the need to create one manually via PutConfiguredAudienceModelPolicyRequest.builder()

Parameters:

putConfiguredAudienceModelPolicyRequest - A Consumer that will call methods on PutConfiguredAudienceModelPolicyRequest.Builder to create a request.

Returns:

Result of the PutConfiguredAudienceModelPolicy operation returned by the service.

See Also:

• AWS API Documentation

startAudienceExportJob

default StartAudienceExportJobResponse startAudienceExportJob(StartAudienceExportJobRequest startAudienceExportJobRequest)
                                                       throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

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

Parameters:

startAudienceExportJobRequest -

Returns:

Result of the StartAudienceExportJob operation returned by the service.

See Also:

• AWS API Documentation

startAudienceExportJob

default StartAudienceExportJobResponse startAudienceExportJob(Consumer<StartAudienceExportJobRequest.Builder> startAudienceExportJobRequest)
                                                       throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

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

This is a convenience which creates an instance of the StartAudienceExportJobRequest.Builder avoiding the need to create one manually via StartAudienceExportJobRequest.builder()

Parameters:

startAudienceExportJobRequest - A Consumer that will call methods on StartAudienceExportJobRequest.Builder to create a request.

Returns:

Result of the StartAudienceExportJob operation returned by the service.

See Also:

• AWS API Documentation

startAudienceGenerationJob

default StartAudienceGenerationJobResponse startAudienceGenerationJob(StartAudienceGenerationJobRequest startAudienceGenerationJobRequest)
                                                               throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Information necessary to start the audience generation job.

Parameters:

startAudienceGenerationJobRequest -

Returns:

Result of the StartAudienceGenerationJob operation returned by the service.

See Also:

• AWS API Documentation

startAudienceGenerationJob

default StartAudienceGenerationJobResponse startAudienceGenerationJob(Consumer<StartAudienceGenerationJobRequest.Builder> startAudienceGenerationJobRequest)
                                                               throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
ServiceQuotaExceededException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Information necessary to start the audience generation job.

This is a convenience which creates an instance of the StartAudienceGenerationJobRequest.Builder avoiding the need to create one manually via StartAudienceGenerationJobRequest.builder()

Parameters:

startAudienceGenerationJobRequest - A Consumer that will call methods on StartAudienceGenerationJobRequest.Builder to create a request.

Returns:

Result of the StartAudienceGenerationJob operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest)
                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Adds metadata tags to a specified resource.

Parameters:

tagResourceRequest -

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

tagResource

default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
                                 throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Adds metadata tags to a specified resource.

This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to create one manually via TagResourceRequest.builder()

Parameters:

tagResourceRequest - A Consumer that will call methods on TagResourceRequest.Builder to create a request.

Returns:

Result of the TagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest)
                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Removes metadata tags from a specified resource.

Parameters:

untagResourceRequest -

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

untagResource

default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
                                     throws ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Removes metadata tags from a specified resource.

This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to create one manually via UntagResourceRequest.builder()

Parameters:

untagResourceRequest - A Consumer that will call methods on UntagResourceRequest.Builder to create a request.

Returns:

Result of the UntagResource operation returned by the service.

See Also:

• AWS API Documentation

updateConfiguredAudienceModel

default UpdateConfiguredAudienceModelResponse updateConfiguredAudienceModel(UpdateConfiguredAudienceModelRequest updateConfiguredAudienceModelRequest)
                                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

Parameters:

updateConfiguredAudienceModelRequest -

Returns:

Result of the UpdateConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

updateConfiguredAudienceModel

default UpdateConfiguredAudienceModelResponse updateConfiguredAudienceModel(Consumer<UpdateConfiguredAudienceModelRequest.Builder> updateConfiguredAudienceModelRequest)
                                                                     throws ConflictException,
ValidationException,
AccessDeniedException,
ResourceNotFoundException,
AwsServiceException,
SdkClientException,
CleanRoomsMlException

Provides the information necessary to update a configured audience model. Updates that impact audience generation jobs take effect when a new job starts, but do not impact currently running jobs.

This is a convenience which creates an instance of the UpdateConfiguredAudienceModelRequest.Builder avoiding the need to create one manually via UpdateConfiguredAudienceModelRequest.builder()

Parameters:

updateConfiguredAudienceModelRequest - A Consumer that will call methods on UpdateConfiguredAudienceModelRequest.Builder to create a request.

Returns:

Result of the UpdateConfiguredAudienceModel operation returned by the service.

See Also:

• AWS API Documentation

create

static CleanRoomsMlClient create()

Create a CleanRoomsMlClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static CleanRoomsMlClientBuilder builder()

Create a builder that can be used to configure and create a CleanRoomsMlClient.

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default CleanRoomsMlServiceClientConfiguration serviceClientConfiguration()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration