Skip to content

Type definitions#

Index > CleanRoomsML > Type definitions

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

TimestampTypeDef#

# TimestampTypeDef definition

TimestampTypeDef = Union[
    datetime,
    str,
]

S3ConfigMapTypeDef#

# S3ConfigMapTypeDef definition

class S3ConfigMapTypeDef(TypedDict):
    s3Uri: str,

AudienceSizeTypeDef#

# AudienceSizeTypeDef definition

class AudienceSizeTypeDef(TypedDict):
    type: AudienceSizeTypeType,  # (1)
    value: int,
  1. See AudienceSizeTypeType

StatusDetailsTypeDef#

# StatusDetailsTypeDef definition

class StatusDetailsTypeDef(TypedDict):
    message: NotRequired[str],
    statusCode: NotRequired[str],

AudienceGenerationJobSummaryTypeDef#

# AudienceGenerationJobSummaryTypeDef definition

class AudienceGenerationJobSummaryTypeDef(TypedDict):
    audienceGenerationJobArn: str,
    configuredAudienceModelArn: str,
    createTime: datetime,
    name: str,
    status: AudienceGenerationJobStatusType,  # (1)
    updateTime: datetime,
    collaborationId: NotRequired[str],
    description: NotRequired[str],
    startedBy: NotRequired[str],
  1. See AudienceGenerationJobStatusType

AudienceModelMetricTypeDef#

# AudienceModelMetricTypeDef definition

class AudienceModelMetricTypeDef(TypedDict):
    forTopKItemPredictions: int,
    type: AudienceModelMetricTypeType,  # (1)
    value: float,
  1. See AudienceModelMetricTypeType

AudienceModelSummaryTypeDef#

# AudienceModelSummaryTypeDef definition

class AudienceModelSummaryTypeDef(TypedDict):
    audienceModelArn: str,
    createTime: datetime,
    name: str,
    status: AudienceModelStatusType,  # (1)
    trainingDatasetArn: str,
    updateTime: datetime,
    description: NotRequired[str],
  1. See AudienceModelStatusType

AudienceSizeConfigTypeDef#

# AudienceSizeConfigTypeDef definition

class AudienceSizeConfigTypeDef(TypedDict):
    audienceSizeBins: Sequence[int],
    audienceSizeType: AudienceSizeTypeType,  # (1)
  1. See AudienceSizeTypeType

ColumnSchemaTypeDef#

# ColumnSchemaTypeDef definition

class ColumnSchemaTypeDef(TypedDict):
    columnName: str,
    columnTypes: Sequence[ColumnTypeType],  # (1)
  1. See ColumnTypeType

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

class ResponseMetadataTypeDef(TypedDict):
    RequestId: str,
    HTTPStatusCode: int,
    HTTPHeaders: Dict[str, str],
    RetryAttempts: int,
    HostId: NotRequired[str],

GlueDataSourceTypeDef#

# GlueDataSourceTypeDef definition

class GlueDataSourceTypeDef(TypedDict):
    databaseName: str,
    tableName: str,
    catalogId: NotRequired[str],

DeleteAudienceGenerationJobRequestRequestTypeDef#

# DeleteAudienceGenerationJobRequestRequestTypeDef definition

class DeleteAudienceGenerationJobRequestRequestTypeDef(TypedDict):
    audienceGenerationJobArn: str,

DeleteAudienceModelRequestRequestTypeDef#

# DeleteAudienceModelRequestRequestTypeDef definition

class DeleteAudienceModelRequestRequestTypeDef(TypedDict):
    audienceModelArn: str,

DeleteConfiguredAudienceModelPolicyRequestRequestTypeDef#

# DeleteConfiguredAudienceModelPolicyRequestRequestTypeDef definition

class DeleteConfiguredAudienceModelPolicyRequestRequestTypeDef(TypedDict):
    configuredAudienceModelArn: str,

DeleteConfiguredAudienceModelRequestRequestTypeDef#

# DeleteConfiguredAudienceModelRequestRequestTypeDef definition

class DeleteConfiguredAudienceModelRequestRequestTypeDef(TypedDict):
    configuredAudienceModelArn: str,

DeleteTrainingDatasetRequestRequestTypeDef#

# DeleteTrainingDatasetRequestRequestTypeDef definition

class DeleteTrainingDatasetRequestRequestTypeDef(TypedDict):
    trainingDatasetArn: str,

GetAudienceGenerationJobRequestRequestTypeDef#

# GetAudienceGenerationJobRequestRequestTypeDef definition

class GetAudienceGenerationJobRequestRequestTypeDef(TypedDict):
    audienceGenerationJobArn: str,

GetAudienceModelRequestRequestTypeDef#

# GetAudienceModelRequestRequestTypeDef definition

class GetAudienceModelRequestRequestTypeDef(TypedDict):
    audienceModelArn: str,

GetConfiguredAudienceModelPolicyRequestRequestTypeDef#

# GetConfiguredAudienceModelPolicyRequestRequestTypeDef definition

class GetConfiguredAudienceModelPolicyRequestRequestTypeDef(TypedDict):
    configuredAudienceModelArn: str,

GetConfiguredAudienceModelRequestRequestTypeDef#

# GetConfiguredAudienceModelRequestRequestTypeDef definition

class GetConfiguredAudienceModelRequestRequestTypeDef(TypedDict):
    configuredAudienceModelArn: str,

GetTrainingDatasetRequestRequestTypeDef#

# GetTrainingDatasetRequestRequestTypeDef definition

class GetTrainingDatasetRequestRequestTypeDef(TypedDict):
    trainingDatasetArn: str,

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

class PaginatorConfigTypeDef(TypedDict):
    MaxItems: NotRequired[int],
    PageSize: NotRequired[int],
    StartingToken: NotRequired[str],

ListAudienceExportJobsRequestRequestTypeDef#

# ListAudienceExportJobsRequestRequestTypeDef definition

class ListAudienceExportJobsRequestRequestTypeDef(TypedDict):
    audienceGenerationJobArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAudienceGenerationJobsRequestRequestTypeDef#

# ListAudienceGenerationJobsRequestRequestTypeDef definition

class ListAudienceGenerationJobsRequestRequestTypeDef(TypedDict):
    collaborationId: NotRequired[str],
    configuredAudienceModelArn: NotRequired[str],
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListAudienceModelsRequestRequestTypeDef#

# ListAudienceModelsRequestRequestTypeDef definition

class ListAudienceModelsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListConfiguredAudienceModelsRequestRequestTypeDef#

# ListConfiguredAudienceModelsRequestRequestTypeDef definition

class ListConfiguredAudienceModelsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

ListTrainingDatasetsRequestRequestTypeDef#

# ListTrainingDatasetsRequestRequestTypeDef definition

class ListTrainingDatasetsRequestRequestTypeDef(TypedDict):
    maxResults: NotRequired[int],
    nextToken: NotRequired[str],

TrainingDatasetSummaryTypeDef#

# TrainingDatasetSummaryTypeDef definition

class TrainingDatasetSummaryTypeDef(TypedDict):
    createTime: datetime,
    name: str,
    status: TrainingDatasetStatusType,  # (1)
    trainingDatasetArn: str,
    updateTime: datetime,
    description: NotRequired[str],
  1. See TrainingDatasetStatusType

PutConfiguredAudienceModelPolicyRequestRequestTypeDef#

# PutConfiguredAudienceModelPolicyRequestRequestTypeDef definition

class PutConfiguredAudienceModelPolicyRequestRequestTypeDef(TypedDict):
    configuredAudienceModelArn: str,
    configuredAudienceModelPolicy: str,
    policyExistenceCondition: NotRequired[PolicyExistenceConditionType],  # (1)
    previousPolicyHash: NotRequired[str],
  1. See PolicyExistenceConditionType

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Mapping[str, str],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

class UntagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tagKeys: Sequence[str],

AudienceDestinationTypeDef#

# AudienceDestinationTypeDef definition

class AudienceDestinationTypeDef(TypedDict):
    s3Destination: S3ConfigMapTypeDef,  # (1)
  1. See S3ConfigMapTypeDef

AudienceGenerationJobDataSourceTypeDef#

# AudienceGenerationJobDataSourceTypeDef definition

class AudienceGenerationJobDataSourceTypeDef(TypedDict):
    dataSource: S3ConfigMapTypeDef,  # (1)
    roleArn: str,
  1. See S3ConfigMapTypeDef

RelevanceMetricTypeDef#

# RelevanceMetricTypeDef definition

class RelevanceMetricTypeDef(TypedDict):
    audienceSize: AudienceSizeTypeDef,  # (1)
    score: NotRequired[float],
  1. See AudienceSizeTypeDef

StartAudienceExportJobRequestRequestTypeDef#

# StartAudienceExportJobRequestRequestTypeDef definition

class StartAudienceExportJobRequestRequestTypeDef(TypedDict):
    audienceGenerationJobArn: str,
    audienceSize: AudienceSizeTypeDef,  # (1)
    name: str,
    description: NotRequired[str],
  1. See AudienceSizeTypeDef

AudienceExportJobSummaryTypeDef#

# AudienceExportJobSummaryTypeDef definition

class AudienceExportJobSummaryTypeDef(TypedDict):
    audienceGenerationJobArn: str,
    audienceSize: AudienceSizeTypeDef,  # (1)
    createTime: datetime,
    name: str,
    status: AudienceExportJobStatusType,  # (2)
    updateTime: datetime,
    description: NotRequired[str],
    outputLocation: NotRequired[str],
    statusDetails: NotRequired[StatusDetailsTypeDef],  # (3)
  1. See AudienceSizeTypeDef
  2. See AudienceExportJobStatusType
  3. See StatusDetailsTypeDef

CreateAudienceModelRequestRequestTypeDef#

# CreateAudienceModelRequestRequestTypeDef definition

class CreateAudienceModelRequestRequestTypeDef(TypedDict):
    name: str,
    trainingDatasetArn: str,
    description: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    tags: NotRequired[Mapping[str, str]],
    trainingDataEndTime: NotRequired[Union[datetime, str]],
    trainingDataStartTime: NotRequired[Union[datetime, str]],

CreateAudienceModelResponseTypeDef#

# CreateAudienceModelResponseTypeDef definition

class CreateAudienceModelResponseTypeDef(TypedDict):
    audienceModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateConfiguredAudienceModelResponseTypeDef#

# CreateConfiguredAudienceModelResponseTypeDef definition

class CreateConfiguredAudienceModelResponseTypeDef(TypedDict):
    configuredAudienceModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateTrainingDatasetResponseTypeDef#

# CreateTrainingDatasetResponseTypeDef definition

class CreateTrainingDatasetResponseTypeDef(TypedDict):
    trainingDatasetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

class EmptyResponseMetadataTypeDef(TypedDict):
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

GetAudienceModelResponseTypeDef#

# GetAudienceModelResponseTypeDef definition

class GetAudienceModelResponseTypeDef(TypedDict):
    audienceModelArn: str,
    createTime: datetime,
    description: str,
    kmsKeyArn: str,
    metrics: List[AudienceModelMetricTypeDef],  # (1)
    name: str,
    status: AudienceModelStatusType,  # (2)
    statusDetails: StatusDetailsTypeDef,  # (3)
    tags: Dict[str, str],
    trainingDataEndTime: datetime,
    trainingDataStartTime: datetime,
    trainingDatasetArn: str,
    updateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (4)
  1. See AudienceModelMetricTypeDef
  2. See AudienceModelStatusType
  3. See StatusDetailsTypeDef
  4. See ResponseMetadataTypeDef

GetConfiguredAudienceModelPolicyResponseTypeDef#

# GetConfiguredAudienceModelPolicyResponseTypeDef definition

class GetConfiguredAudienceModelPolicyResponseTypeDef(TypedDict):
    configuredAudienceModelArn: str,
    configuredAudienceModelPolicy: str,
    policyHash: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListAudienceGenerationJobsResponseTypeDef#

# ListAudienceGenerationJobsResponseTypeDef definition

class ListAudienceGenerationJobsResponseTypeDef(TypedDict):
    audienceGenerationJobs: List[AudienceGenerationJobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AudienceGenerationJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListAudienceModelsResponseTypeDef#

# ListAudienceModelsResponseTypeDef definition

class ListAudienceModelsResponseTypeDef(TypedDict):
    audienceModels: List[AudienceModelSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AudienceModelSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: Dict[str, str],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

PutConfiguredAudienceModelPolicyResponseTypeDef#

# PutConfiguredAudienceModelPolicyResponseTypeDef definition

class PutConfiguredAudienceModelPolicyResponseTypeDef(TypedDict):
    configuredAudienceModelPolicy: str,
    policyHash: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StartAudienceGenerationJobResponseTypeDef#

# StartAudienceGenerationJobResponseTypeDef definition

class StartAudienceGenerationJobResponseTypeDef(TypedDict):
    audienceGenerationJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateConfiguredAudienceModelResponseTypeDef#

# UpdateConfiguredAudienceModelResponseTypeDef definition

class UpdateConfiguredAudienceModelResponseTypeDef(TypedDict):
    configuredAudienceModelArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

DataSourceTypeDef#

# DataSourceTypeDef definition

class DataSourceTypeDef(TypedDict):
    glueDataSource: GlueDataSourceTypeDef,  # (1)
  1. See GlueDataSourceTypeDef

ListAudienceExportJobsRequestListAudienceExportJobsPaginateTypeDef#

# ListAudienceExportJobsRequestListAudienceExportJobsPaginateTypeDef definition

class ListAudienceExportJobsRequestListAudienceExportJobsPaginateTypeDef(TypedDict):
    audienceGenerationJobArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAudienceGenerationJobsRequestListAudienceGenerationJobsPaginateTypeDef#

# ListAudienceGenerationJobsRequestListAudienceGenerationJobsPaginateTypeDef definition

class ListAudienceGenerationJobsRequestListAudienceGenerationJobsPaginateTypeDef(TypedDict):
    collaborationId: NotRequired[str],
    configuredAudienceModelArn: NotRequired[str],
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListAudienceModelsRequestListAudienceModelsPaginateTypeDef#

# ListAudienceModelsRequestListAudienceModelsPaginateTypeDef definition

class ListAudienceModelsRequestListAudienceModelsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListConfiguredAudienceModelsRequestListConfiguredAudienceModelsPaginateTypeDef#

# ListConfiguredAudienceModelsRequestListConfiguredAudienceModelsPaginateTypeDef definition

class ListConfiguredAudienceModelsRequestListConfiguredAudienceModelsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTrainingDatasetsRequestListTrainingDatasetsPaginateTypeDef#

# ListTrainingDatasetsRequestListTrainingDatasetsPaginateTypeDef definition

class ListTrainingDatasetsRequestListTrainingDatasetsPaginateTypeDef(TypedDict):
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (1)
  1. See PaginatorConfigTypeDef

ListTrainingDatasetsResponseTypeDef#

# ListTrainingDatasetsResponseTypeDef definition

class ListTrainingDatasetsResponseTypeDef(TypedDict):
    nextToken: str,
    trainingDatasets: List[TrainingDatasetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TrainingDatasetSummaryTypeDef
  2. See ResponseMetadataTypeDef

ConfiguredAudienceModelOutputConfigTypeDef#

# ConfiguredAudienceModelOutputConfigTypeDef definition

class ConfiguredAudienceModelOutputConfigTypeDef(TypedDict):
    destination: AudienceDestinationTypeDef,  # (1)
    roleArn: str,
  1. See AudienceDestinationTypeDef

StartAudienceGenerationJobRequestRequestTypeDef#

# StartAudienceGenerationJobRequestRequestTypeDef definition

class StartAudienceGenerationJobRequestRequestTypeDef(TypedDict):
    configuredAudienceModelArn: str,
    name: str,
    seedAudience: AudienceGenerationJobDataSourceTypeDef,  # (1)
    collaborationId: NotRequired[str],
    description: NotRequired[str],
    includeSeedInOutput: NotRequired[bool],
    tags: NotRequired[Mapping[str, str]],
  1. See AudienceGenerationJobDataSourceTypeDef

AudienceQualityMetricsTypeDef#

# AudienceQualityMetricsTypeDef definition

class AudienceQualityMetricsTypeDef(TypedDict):
    relevanceMetrics: List[RelevanceMetricTypeDef],  # (1)
  1. See RelevanceMetricTypeDef

ListAudienceExportJobsResponseTypeDef#

# ListAudienceExportJobsResponseTypeDef definition

class ListAudienceExportJobsResponseTypeDef(TypedDict):
    audienceExportJobs: List[AudienceExportJobSummaryTypeDef],  # (1)
    nextToken: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AudienceExportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

DatasetInputConfigTypeDef#

# DatasetInputConfigTypeDef definition

class DatasetInputConfigTypeDef(TypedDict):
    dataSource: DataSourceTypeDef,  # (1)
    schema: Sequence[ColumnSchemaTypeDef],  # (2)
  1. See DataSourceTypeDef
  2. See ColumnSchemaTypeDef

ConfiguredAudienceModelSummaryTypeDef#

# ConfiguredAudienceModelSummaryTypeDef definition

class ConfiguredAudienceModelSummaryTypeDef(TypedDict):
    audienceModelArn: str,
    configuredAudienceModelArn: str,
    createTime: datetime,
    name: str,
    outputConfig: ConfiguredAudienceModelOutputConfigTypeDef,  # (1)
    status: ConfiguredAudienceModelStatusType,  # (2)
    updateTime: datetime,
    description: NotRequired[str],
  1. See ConfiguredAudienceModelOutputConfigTypeDef
  2. See ConfiguredAudienceModelStatusType

CreateConfiguredAudienceModelRequestRequestTypeDef#

# CreateConfiguredAudienceModelRequestRequestTypeDef definition

class CreateConfiguredAudienceModelRequestRequestTypeDef(TypedDict):
    audienceModelArn: str,
    name: str,
    outputConfig: ConfiguredAudienceModelOutputConfigTypeDef,  # (1)
    sharedAudienceMetrics: Sequence[SharedAudienceMetricsType],  # (2)
    audienceSizeConfig: NotRequired[AudienceSizeConfigTypeDef],  # (3)
    childResourceTagOnCreatePolicy: NotRequired[TagOnCreatePolicyType],  # (4)
    description: NotRequired[str],
    minMatchingSeedSize: NotRequired[int],
    tags: NotRequired[Mapping[str, str]],
  1. See ConfiguredAudienceModelOutputConfigTypeDef
  2. See SharedAudienceMetricsType
  3. See AudienceSizeConfigTypeDef
  4. See TagOnCreatePolicyType

GetConfiguredAudienceModelResponseTypeDef#

# GetConfiguredAudienceModelResponseTypeDef definition

class GetConfiguredAudienceModelResponseTypeDef(TypedDict):
    audienceModelArn: str,
    audienceSizeConfig: AudienceSizeConfigTypeDef,  # (1)
    childResourceTagOnCreatePolicy: TagOnCreatePolicyType,  # (2)
    configuredAudienceModelArn: str,
    createTime: datetime,
    description: str,
    minMatchingSeedSize: int,
    name: str,
    outputConfig: ConfiguredAudienceModelOutputConfigTypeDef,  # (3)
    sharedAudienceMetrics: List[SharedAudienceMetricsType],  # (4)
    status: ConfiguredAudienceModelStatusType,  # (5)
    tags: Dict[str, str],
    updateTime: datetime,
    ResponseMetadata: ResponseMetadataTypeDef,  # (6)
  1. See AudienceSizeConfigTypeDef
  2. See TagOnCreatePolicyType
  3. See ConfiguredAudienceModelOutputConfigTypeDef
  4. See SharedAudienceMetricsType
  5. See ConfiguredAudienceModelStatusType
  6. See ResponseMetadataTypeDef

UpdateConfiguredAudienceModelRequestRequestTypeDef#