Skip to content

Cleanroomsml Classes

AudienceDestinationTypeDef

s3Destination

  • Type:
  • Required: Yes

AudienceExportJobSummaryTypeDef

audienceGenerationJobArn

  • Type:
  • Required: Yes

audienceSize

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'CREATE_PENDING']
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

outputLocation

  • Type: typing.Optional[str]

statusDetails

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.StatusDetailsTypeDef]

AudienceGenerationJobDataSourceTypeDef

dataSource

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

AudienceGenerationJobSummaryTypeDef

audienceGenerationJobArn

  • Type:
  • Required: Yes

configuredAudienceModelArn

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'CREATE_PENDING', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'DELETE_PENDING']
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

collaborationId

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

startedBy

  • Type: typing.Optional[str]

AudienceModelSummaryTypeDef

audienceModelArn

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'CREATE_PENDING', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'DELETE_PENDING']
  • Required: Yes

trainingDatasetArn

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

AudienceQualityMetricsTypeDef

relevanceMetrics

  • Type: typing.List[aws_resource_validator.pydantic_models.cleanroomsml_classes.RelevanceMetricTypeDef]
  • Required: Yes

recallMetric

  • Type: typing.Optional[float]

AudienceSizeConfigTypeDef

audienceSizeBins

  • Type: typing.Sequence[int]
  • Required: Yes

audienceSizeType

  • Type: typing.Literal['ABSOLUTE', 'PERCENTAGE']
  • Required: Yes

AudienceSizeTypeDef

type

  • Type: typing.Literal['ABSOLUTE', 'PERCENTAGE']
  • Required: Yes

value

  • Type:
  • Required: Yes

BaseValidatorModel

Oops! This Pydantic model is currently empty. Stay tuned!

ColumnSchemaTypeDef

columnName

  • Type:
  • Required: Yes

columnTypes

  • Type: typing.Sequence[typing.Literal['CATEGORICAL_FEATURE', 'ITEM_ID', 'NUMERICAL_FEATURE', 'TIMESTAMP', 'USER_ID']]
  • Required: Yes

ConfiguredAudienceModelOutputConfigTypeDef

destination

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

ConfiguredAudienceModelSummaryTypeDef

audienceModelArn

  • Type:
  • Required: Yes

configuredAudienceModelArn

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

outputConfig

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE']
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

CreateAudienceModelRequestRequestTypeDef

name

  • Type:
  • Required: Yes

trainingDatasetArn

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

kmsKeyArn

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

trainingDataEndTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

trainingDataStartTime

  • Type: typing.Union[datetime.datetime, str, NoneType]

CreateAudienceModelResponseTypeDef

audienceModelArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateConfiguredAudienceModelRequestRequestTypeDef

audienceModelArn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

outputConfig

  • Type:
  • Required: Yes

sharedAudienceMetrics

  • Type: typing.Sequence[typing.Literal['ALL', 'NONE']]
  • Required: Yes

audienceSizeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.AudienceSizeConfigTypeDef]

childResourceTagOnCreatePolicy

  • Type: typing.Optional[typing.Literal['FROM_PARENT_RESOURCE', 'NONE']]

description

  • Type: typing.Optional[str]

minMatchingSeedSize

  • Type: typing.Optional[int]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateConfiguredAudienceModelResponseTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

CreateTrainingDatasetRequestRequestTypeDef

name

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

trainingData

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.cleanroomsml_classes.DatasetTypeDef]
  • Required: Yes

description

  • Type: typing.Optional[str]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

CreateTrainingDatasetResponseTypeDef

trainingDatasetArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

DataSourceTypeDef

glueDataSource

  • Type:
  • Required: Yes

DatasetInputConfigTypeDef

dataSource

  • Type:
  • Required: Yes

schema

  • Type: typing.Sequence[aws_resource_validator.pydantic_models.cleanroomsml_classes.ColumnSchemaTypeDef]
  • Default: >

DatasetTypeDef

inputConfig

  • Type:
  • Required: Yes

type

  • Type: typing.Literal['INTERACTIONS']
  • Required: Yes

DeleteAudienceGenerationJobRequestRequestTypeDef

audienceGenerationJobArn

  • Type:
  • Required: Yes

DeleteAudienceModelRequestRequestTypeDef

audienceModelArn

  • Type:
  • Required: Yes

DeleteConfiguredAudienceModelPolicyRequestRequestTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

DeleteConfiguredAudienceModelRequestRequestTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

DeleteTrainingDatasetRequestRequestTypeDef

trainingDatasetArn

  • Type:
  • Required: Yes

EmptyResponseMetadataTypeDef

ResponseMetadata

  • Type:
  • Required: Yes

GetAudienceGenerationJobRequestRequestTypeDef

audienceGenerationJobArn

  • Type:
  • Required: Yes

GetAudienceGenerationJobResponseTypeDef

audienceGenerationJobArn

  • Type:
  • Required: Yes

collaborationId

  • Type:
  • Required: Yes

configuredAudienceModelArn

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

includeSeedInOutput

  • Type:
  • Required: Yes

metrics

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

seedAudience

  • Type:
  • Required: Yes

startedBy

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'CREATE_PENDING', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'DELETE_PENDING']
  • Required: Yes

statusDetails

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetAudienceModelRequestRequestTypeDef

audienceModelArn

  • Type:
  • Required: Yes

GetAudienceModelResponseTypeDef

audienceModelArn

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

kmsKeyArn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE', 'CREATE_FAILED', 'CREATE_IN_PROGRESS', 'CREATE_PENDING', 'DELETE_FAILED', 'DELETE_IN_PROGRESS', 'DELETE_PENDING']
  • Required: Yes

statusDetails

  • Type:
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

trainingDataEndTime

  • Type:
  • Required: Yes

trainingDataStartTime

  • Type:
  • Required: Yes

trainingDatasetArn

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetConfiguredAudienceModelPolicyRequestRequestTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

GetConfiguredAudienceModelPolicyResponseTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

configuredAudienceModelPolicy

  • Type:
  • Required: Yes

policyHash

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetConfiguredAudienceModelRequestRequestTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

GetConfiguredAudienceModelResponseTypeDef

audienceModelArn

  • Type:
  • Required: Yes

audienceSizeConfig

  • Type:
  • Required: Yes

childResourceTagOnCreatePolicy

  • Type: typing.Literal['FROM_PARENT_RESOURCE', 'NONE']
  • Required: Yes

configuredAudienceModelArn

  • Type:
  • Required: Yes

createTime

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

minMatchingSeedSize

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

outputConfig

  • Type:
  • Required: Yes

sharedAudienceMetrics

  • Type: typing.List[typing.Literal['ALL', 'NONE']]
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE']
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GetTrainingDatasetRequestRequestTypeDef

trainingDatasetArn

  • Type:
  • Required: Yes

GetTrainingDatasetResponseTypeDef

createTime

  • Type:
  • Required: Yes

description

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

roleArn

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE']
  • Required: Yes

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

trainingData

  • Type: typing.List[aws_resource_validator.pydantic_models.cleanroomsml_classes.DatasetTypeDef]
  • Required: Yes

trainingDatasetArn

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

GlueDataSourceTypeDef

databaseName

  • Type:
  • Required: Yes

tableName

  • Type:
  • Required: Yes

catalogId

  • Type: typing.Optional[str]

ListAudienceExportJobsRequestListAudienceExportJobsPaginateTypeDef

audienceGenerationJobArn

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.PaginatorConfigTypeDef]

ListAudienceExportJobsRequestRequestTypeDef

audienceGenerationJobArn

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAudienceExportJobsResponseTypeDef

audienceExportJobs

  • Type: typing.List[aws_resource_validator.pydantic_models.cleanroomsml_classes.AudienceExportJobSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAudienceGenerationJobsRequestListAudienceGenerationJobsPaginateTypeDef

collaborationId

  • Type: typing.Optional[str]

configuredAudienceModelArn

  • Type: typing.Optional[str]

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.PaginatorConfigTypeDef]

ListAudienceGenerationJobsRequestRequestTypeDef

collaborationId

  • Type: typing.Optional[str]

configuredAudienceModelArn

  • Type: typing.Optional[str]

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAudienceGenerationJobsResponseTypeDef

audienceGenerationJobs

  • Type: typing.List[aws_resource_validator.pydantic_models.cleanroomsml_classes.AudienceGenerationJobSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListAudienceModelsRequestListAudienceModelsPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.PaginatorConfigTypeDef]

ListAudienceModelsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListAudienceModelsResponseTypeDef

audienceModels

  • Type: typing.List[aws_resource_validator.pydantic_models.cleanroomsml_classes.AudienceModelSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListConfiguredAudienceModelsRequestListConfiguredAudienceModelsPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.PaginatorConfigTypeDef]

ListConfiguredAudienceModelsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListConfiguredAudienceModelsResponseTypeDef

configuredAudienceModels

  • Type: typing.List[aws_resource_validator.pydantic_models.cleanroomsml_classes.ConfiguredAudienceModelSummaryTypeDef]
  • Required: Yes

nextToken

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTagsForResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

ListTagsForResourceResponseTypeDef

tags

  • Type: typing.Dict[str, str]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

ListTrainingDatasetsRequestListTrainingDatasetsPaginateTypeDef

PaginationConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.PaginatorConfigTypeDef]

ListTrainingDatasetsRequestRequestTypeDef

maxResults

  • Type: typing.Optional[int]

nextToken

  • Type: typing.Optional[str]

ListTrainingDatasetsResponseTypeDef

nextToken

  • Type:
  • Required: Yes

trainingDatasets

  • Type: typing.List[aws_resource_validator.pydantic_models.cleanroomsml_classes.TrainingDatasetSummaryTypeDef]
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

PaginatorConfigTypeDef

MaxItems

  • Type: typing.Optional[int]

PageSize

  • Type: typing.Optional[int]

StartingToken

  • Type: typing.Optional[str]

PutConfiguredAudienceModelPolicyRequestRequestTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

configuredAudienceModelPolicy

  • Type:
  • Required: Yes

policyExistenceCondition

  • Type: typing.Optional[typing.Literal['POLICY_MUST_EXIST', 'POLICY_MUST_NOT_EXIST']]

previousPolicyHash

  • Type: typing.Optional[str]

PutConfiguredAudienceModelPolicyResponseTypeDef

configuredAudienceModelPolicy

  • Type:
  • Required: Yes

policyHash

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

RelevanceMetricTypeDef

audienceSize

  • Type:
  • Required: Yes

score

  • Type: typing.Optional[float]

ResponseMetadataTypeDef

RequestId

  • Type:
  • Required: Yes

HTTPStatusCode

  • Type:
  • Required: Yes

HTTPHeaders

  • Type: typing.Dict[str, str]
  • Required: Yes

RetryAttempts

  • Type:
  • Required: Yes

HostId

  • Type: typing.Optional[str]

S3ConfigMapTypeDef

s3Uri

  • Type:
  • Required: Yes

StartAudienceExportJobRequestRequestTypeDef

audienceGenerationJobArn

  • Type:
  • Required: Yes

audienceSize

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

StartAudienceGenerationJobRequestRequestTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

seedAudience

  • Type:
  • Required: Yes

collaborationId

  • Type: typing.Optional[str]

description

  • Type: typing.Optional[str]

includeSeedInOutput

  • Type: typing.Optional[bool]

tags

  • Type: typing.Optional[typing.Mapping[str, str]]

StartAudienceGenerationJobResponseTypeDef

audienceGenerationJobArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes

StatusDetailsTypeDef

message

  • Type: typing.Optional[str]

statusCode

  • Type: typing.Optional[str]

TagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tags

  • Type: typing.Mapping[str, str]
  • Required: Yes

TrainingDatasetSummaryTypeDef

createTime

  • Type:
  • Required: Yes

name

  • Type:
  • Required: Yes

status

  • Type: typing.Literal['ACTIVE']
  • Required: Yes

trainingDatasetArn

  • Type:
  • Required: Yes

updateTime

  • Type:
  • Required: Yes

description

  • Type: typing.Optional[str]

UntagResourceRequestRequestTypeDef

resourceArn

  • Type:
  • Required: Yes

tagKeys

  • Type: typing.Sequence[str]
  • Required: Yes

UpdateConfiguredAudienceModelRequestRequestTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

audienceModelArn

  • Type: typing.Optional[str]

audienceSizeConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.AudienceSizeConfigTypeDef]

description

  • Type: typing.Optional[str]

minMatchingSeedSize

  • Type: typing.Optional[int]

outputConfig

  • Type: typing.Optional[aws_resource_validator.pydantic_models.cleanroomsml_classes.ConfiguredAudienceModelOutputConfigTypeDef]

sharedAudienceMetrics

  • Type: typing.Optional[typing.Sequence[typing.Literal['ALL', 'NONE']]]

UpdateConfiguredAudienceModelResponseTypeDef

configuredAudienceModelArn

  • Type:
  • Required: Yes

ResponseMetadata

  • Type:
  • Required: Yes