Skip to content

Type definitions#

Index > Personalize > Type definitions

Auto-generated documentation for Personalize type annotations stubs module mypy-boto3-personalize.

AutoMLConfigUnionTypeDef#

# AutoMLConfigUnionTypeDef definition

AutoMLConfigUnionTypeDef = Union[
    AutoMLConfigTypeDef,  # (1)
    AutoMLConfigOutputTypeDef,  # (2)
]
  1. See AutoMLConfigTypeDef
  2. See AutoMLConfigOutputTypeDef

CategoricalHyperParameterRangeUnionTypeDef#

# CategoricalHyperParameterRangeUnionTypeDef definition

CategoricalHyperParameterRangeUnionTypeDef = Union[
    CategoricalHyperParameterRangeTypeDef,  # (1)
    CategoricalHyperParameterRangeOutputTypeDef,  # (2)
]
  1. See CategoricalHyperParameterRangeTypeDef
  2. See CategoricalHyperParameterRangeOutputTypeDef

TrainingDataConfigUnionTypeDef#

# TrainingDataConfigUnionTypeDef definition

TrainingDataConfigUnionTypeDef = Union[
    TrainingDataConfigTypeDef,  # (1)
    TrainingDataConfigOutputTypeDef,  # (2)
]
  1. See TrainingDataConfigTypeDef
  2. See TrainingDataConfigOutputTypeDef

HyperParameterRangesUnionTypeDef#

# HyperParameterRangesUnionTypeDef definition

HyperParameterRangesUnionTypeDef = Union[
    HyperParameterRangesTypeDef,  # (1)
    HyperParameterRangesOutputTypeDef,  # (2)
]
  1. See HyperParameterRangesTypeDef
  2. See HyperParameterRangesOutputTypeDef

HPOConfigUnionTypeDef#

# HPOConfigUnionTypeDef definition

HPOConfigUnionTypeDef = Union[
    HPOConfigTypeDef,  # (1)
    HPOConfigOutputTypeDef,  # (2)
]
  1. See HPOConfigTypeDef
  2. See HPOConfigOutputTypeDef

AlgorithmImageTypeDef#

# AlgorithmImageTypeDef definition

class AlgorithmImageTypeDef(TypedDict):
    dockerURI: str,
    name: NotRequired[str],

AutoMLConfigOutputTypeDef#

# AutoMLConfigOutputTypeDef definition

class AutoMLConfigOutputTypeDef(TypedDict):
    metricName: NotRequired[str],
    recipeList: NotRequired[list[str]],

AutoMLConfigTypeDef#

# AutoMLConfigTypeDef definition

class AutoMLConfigTypeDef(TypedDict):
    metricName: NotRequired[str],
    recipeList: NotRequired[Sequence[str]],

AutoMLResultTypeDef#

# AutoMLResultTypeDef definition

class AutoMLResultTypeDef(TypedDict):
    bestRecipeArn: NotRequired[str],

AutoTrainingConfigTypeDef#

# AutoTrainingConfigTypeDef definition

class AutoTrainingConfigTypeDef(TypedDict):
    schedulingExpression: NotRequired[str],

BatchInferenceJobConfigOutputTypeDef#

# BatchInferenceJobConfigOutputTypeDef definition

class BatchInferenceJobConfigOutputTypeDef(TypedDict):
    itemExplorationConfig: NotRequired[dict[str, str]],

BatchInferenceJobConfigTypeDef#

# BatchInferenceJobConfigTypeDef definition

class BatchInferenceJobConfigTypeDef(TypedDict):
    itemExplorationConfig: NotRequired[Mapping[str, str]],

S3DataConfigTypeDef#

# S3DataConfigTypeDef definition

class S3DataConfigTypeDef(TypedDict):
    path: str,
    kmsKeyArn: NotRequired[str],

BatchInferenceJobSummaryTypeDef#

# BatchInferenceJobSummaryTypeDef definition

class BatchInferenceJobSummaryTypeDef(TypedDict):
    batchInferenceJobArn: NotRequired[str],
    jobName: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
    solutionVersionArn: NotRequired[str],
    batchInferenceJobMode: NotRequired[BatchInferenceJobModeType],  # (1)
  1. See BatchInferenceJobModeType

BatchSegmentJobSummaryTypeDef#

# BatchSegmentJobSummaryTypeDef definition

class BatchSegmentJobSummaryTypeDef(TypedDict):
    batchSegmentJobArn: NotRequired[str],
    jobName: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
    solutionVersionArn: NotRequired[str],

CampaignConfigOutputTypeDef#

# CampaignConfigOutputTypeDef definition

class CampaignConfigOutputTypeDef(TypedDict):
    itemExplorationConfig: NotRequired[dict[str, str]],
    enableMetadataWithRecommendations: NotRequired[bool],
    syncWithLatestSolutionVersion: NotRequired[bool],

CampaignConfigTypeDef#

# CampaignConfigTypeDef definition

class CampaignConfigTypeDef(TypedDict):
    itemExplorationConfig: NotRequired[Mapping[str, str]],
    enableMetadataWithRecommendations: NotRequired[bool],
    syncWithLatestSolutionVersion: NotRequired[bool],

CampaignSummaryTypeDef#

# CampaignSummaryTypeDef definition

class CampaignSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    campaignArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],

CategoricalHyperParameterRangeOutputTypeDef#

# CategoricalHyperParameterRangeOutputTypeDef definition

class CategoricalHyperParameterRangeOutputTypeDef(TypedDict):
    name: NotRequired[str],
    values: NotRequired[list[str]],

CategoricalHyperParameterRangeTypeDef#

# CategoricalHyperParameterRangeTypeDef definition

class CategoricalHyperParameterRangeTypeDef(TypedDict):
    name: NotRequired[str],
    values: NotRequired[Sequence[str]],

ContinuousHyperParameterRangeTypeDef#

# ContinuousHyperParameterRangeTypeDef definition

class ContinuousHyperParameterRangeTypeDef(TypedDict):
    name: NotRequired[str],
    minValue: NotRequired[float],
    maxValue: NotRequired[float],

TagTypeDef#

# TagTypeDef definition

class TagTypeDef(TypedDict):
    tagKey: str,
    tagValue: str,

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef definition

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

DataSourceTypeDef#

# DataSourceTypeDef definition

class DataSourceTypeDef(TypedDict):
    dataLocation: NotRequired[str],

MetricAttributeTypeDef#

# MetricAttributeTypeDef definition

class MetricAttributeTypeDef(TypedDict):
    eventType: str,
    metricName: str,
    expression: str,

CreateSchemaRequestRequestTypeDef#

# CreateSchemaRequestRequestTypeDef definition

class CreateSchemaRequestRequestTypeDef(TypedDict):
    name: str,
    schema: str,
    domain: NotRequired[DomainType],  # (1)
  1. See DomainType

DataDeletionJobSummaryTypeDef#

# DataDeletionJobSummaryTypeDef definition

class DataDeletionJobSummaryTypeDef(TypedDict):
    dataDeletionJobArn: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    jobName: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],

DatasetExportJobSummaryTypeDef#

# DatasetExportJobSummaryTypeDef definition

class DatasetExportJobSummaryTypeDef(TypedDict):
    datasetExportJobArn: NotRequired[str],
    jobName: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],

DatasetGroupSummaryTypeDef#

# DatasetGroupSummaryTypeDef definition

class DatasetGroupSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
    domain: NotRequired[DomainType],  # (1)
  1. See DomainType

DatasetGroupTypeDef#

# DatasetGroupTypeDef definition

class DatasetGroupTypeDef(TypedDict):
    name: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    status: NotRequired[str],
    roleArn: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
    domain: NotRequired[DomainType],  # (1)
  1. See DomainType

DatasetImportJobSummaryTypeDef#

# DatasetImportJobSummaryTypeDef definition

class DatasetImportJobSummaryTypeDef(TypedDict):
    datasetImportJobArn: NotRequired[str],
    jobName: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
    importMode: NotRequired[ImportModeType],  # (1)
  1. See ImportModeType

DatasetSchemaSummaryTypeDef#

# DatasetSchemaSummaryTypeDef definition

class DatasetSchemaSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    schemaArn: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    domain: NotRequired[DomainType],  # (1)
  1. See DomainType

DatasetSchemaTypeDef#

# DatasetSchemaTypeDef definition

class DatasetSchemaTypeDef(TypedDict):
    name: NotRequired[str],
    schemaArn: NotRequired[str],
    schema: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    domain: NotRequired[DomainType],  # (1)
  1. See DomainType

DatasetSummaryTypeDef#

# DatasetSummaryTypeDef definition

class DatasetSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    datasetArn: NotRequired[str],
    datasetType: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],

DatasetUpdateSummaryTypeDef#

# DatasetUpdateSummaryTypeDef definition

class DatasetUpdateSummaryTypeDef(TypedDict):
    schemaArn: NotRequired[str],
    status: NotRequired[str],
    failureReason: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],

DefaultCategoricalHyperParameterRangeTypeDef#

# DefaultCategoricalHyperParameterRangeTypeDef definition

class DefaultCategoricalHyperParameterRangeTypeDef(TypedDict):
    name: NotRequired[str],
    values: NotRequired[list[str]],
    isTunable: NotRequired[bool],

DefaultContinuousHyperParameterRangeTypeDef#

# DefaultContinuousHyperParameterRangeTypeDef definition

class DefaultContinuousHyperParameterRangeTypeDef(TypedDict):
    name: NotRequired[str],
    minValue: NotRequired[float],
    maxValue: NotRequired[float],
    isTunable: NotRequired[bool],

DefaultIntegerHyperParameterRangeTypeDef#

# DefaultIntegerHyperParameterRangeTypeDef definition

class DefaultIntegerHyperParameterRangeTypeDef(TypedDict):
    name: NotRequired[str],
    minValue: NotRequired[int],
    maxValue: NotRequired[int],
    isTunable: NotRequired[bool],

DeleteCampaignRequestRequestTypeDef#

# DeleteCampaignRequestRequestTypeDef definition

class DeleteCampaignRequestRequestTypeDef(TypedDict):
    campaignArn: str,

DeleteDatasetGroupRequestRequestTypeDef#

# DeleteDatasetGroupRequestRequestTypeDef definition

class DeleteDatasetGroupRequestRequestTypeDef(TypedDict):
    datasetGroupArn: str,

DeleteDatasetRequestRequestTypeDef#

# DeleteDatasetRequestRequestTypeDef definition

class DeleteDatasetRequestRequestTypeDef(TypedDict):
    datasetArn: str,

DeleteEventTrackerRequestRequestTypeDef#

# DeleteEventTrackerRequestRequestTypeDef definition

class DeleteEventTrackerRequestRequestTypeDef(TypedDict):
    eventTrackerArn: str,

DeleteFilterRequestRequestTypeDef#

# DeleteFilterRequestRequestTypeDef definition

class DeleteFilterRequestRequestTypeDef(TypedDict):
    filterArn: str,

DeleteMetricAttributionRequestRequestTypeDef#

# DeleteMetricAttributionRequestRequestTypeDef definition

class DeleteMetricAttributionRequestRequestTypeDef(TypedDict):
    metricAttributionArn: str,

DeleteRecommenderRequestRequestTypeDef#

# DeleteRecommenderRequestRequestTypeDef definition

class DeleteRecommenderRequestRequestTypeDef(TypedDict):
    recommenderArn: str,

DeleteSchemaRequestRequestTypeDef#

# DeleteSchemaRequestRequestTypeDef definition

class DeleteSchemaRequestRequestTypeDef(TypedDict):
    schemaArn: str,

DeleteSolutionRequestRequestTypeDef#

# DeleteSolutionRequestRequestTypeDef definition

class DeleteSolutionRequestRequestTypeDef(TypedDict):
    solutionArn: str,

DescribeAlgorithmRequestRequestTypeDef#

# DescribeAlgorithmRequestRequestTypeDef definition

class DescribeAlgorithmRequestRequestTypeDef(TypedDict):
    algorithmArn: str,

DescribeBatchInferenceJobRequestRequestTypeDef#

# DescribeBatchInferenceJobRequestRequestTypeDef definition

class DescribeBatchInferenceJobRequestRequestTypeDef(TypedDict):
    batchInferenceJobArn: str,

DescribeBatchSegmentJobRequestRequestTypeDef#

# DescribeBatchSegmentJobRequestRequestTypeDef definition

class DescribeBatchSegmentJobRequestRequestTypeDef(TypedDict):
    batchSegmentJobArn: str,

DescribeCampaignRequestRequestTypeDef#

# DescribeCampaignRequestRequestTypeDef definition

class DescribeCampaignRequestRequestTypeDef(TypedDict):
    campaignArn: str,

DescribeDataDeletionJobRequestRequestTypeDef#

# DescribeDataDeletionJobRequestRequestTypeDef definition

class DescribeDataDeletionJobRequestRequestTypeDef(TypedDict):
    dataDeletionJobArn: str,

DescribeDatasetExportJobRequestRequestTypeDef#

# DescribeDatasetExportJobRequestRequestTypeDef definition

class DescribeDatasetExportJobRequestRequestTypeDef(TypedDict):
    datasetExportJobArn: str,

DescribeDatasetGroupRequestRequestTypeDef#

# DescribeDatasetGroupRequestRequestTypeDef definition

class DescribeDatasetGroupRequestRequestTypeDef(TypedDict):
    datasetGroupArn: str,

DescribeDatasetImportJobRequestRequestTypeDef#

# DescribeDatasetImportJobRequestRequestTypeDef definition

class DescribeDatasetImportJobRequestRequestTypeDef(TypedDict):
    datasetImportJobArn: str,

DescribeDatasetRequestRequestTypeDef#

# DescribeDatasetRequestRequestTypeDef definition

class DescribeDatasetRequestRequestTypeDef(TypedDict):
    datasetArn: str,

DescribeEventTrackerRequestRequestTypeDef#

# DescribeEventTrackerRequestRequestTypeDef definition

class DescribeEventTrackerRequestRequestTypeDef(TypedDict):
    eventTrackerArn: str,

EventTrackerTypeDef#

# EventTrackerTypeDef definition

class EventTrackerTypeDef(TypedDict):
    name: NotRequired[str],
    eventTrackerArn: NotRequired[str],
    accountId: NotRequired[str],
    trackingId: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],

DescribeFeatureTransformationRequestRequestTypeDef#

# DescribeFeatureTransformationRequestRequestTypeDef definition

class DescribeFeatureTransformationRequestRequestTypeDef(TypedDict):
    featureTransformationArn: str,

FeatureTransformationTypeDef#

# FeatureTransformationTypeDef definition

class FeatureTransformationTypeDef(TypedDict):
    name: NotRequired[str],
    featureTransformationArn: NotRequired[str],
    defaultParameters: NotRequired[dict[str, str]],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    status: NotRequired[str],

DescribeFilterRequestRequestTypeDef#

# DescribeFilterRequestRequestTypeDef definition

class DescribeFilterRequestRequestTypeDef(TypedDict):
    filterArn: str,

FilterTypeDef#

# FilterTypeDef definition

class FilterTypeDef(TypedDict):
    name: NotRequired[str],
    filterArn: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    datasetGroupArn: NotRequired[str],
    failureReason: NotRequired[str],
    filterExpression: NotRequired[str],
    status: NotRequired[str],

DescribeMetricAttributionRequestRequestTypeDef#

# DescribeMetricAttributionRequestRequestTypeDef definition

class DescribeMetricAttributionRequestRequestTypeDef(TypedDict):
    metricAttributionArn: str,

DescribeRecipeRequestRequestTypeDef#

# DescribeRecipeRequestRequestTypeDef definition

class DescribeRecipeRequestRequestTypeDef(TypedDict):
    recipeArn: str,

RecipeTypeDef#

# RecipeTypeDef definition

class RecipeTypeDef(TypedDict):
    name: NotRequired[str],
    recipeArn: NotRequired[str],
    algorithmArn: NotRequired[str],
    featureTransformationArn: NotRequired[str],
    status: NotRequired[str],
    description: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    recipeType: NotRequired[str],
    lastUpdatedDateTime: NotRequired[datetime],

DescribeRecommenderRequestRequestTypeDef#

# DescribeRecommenderRequestRequestTypeDef definition

class DescribeRecommenderRequestRequestTypeDef(TypedDict):
    recommenderArn: str,

DescribeSchemaRequestRequestTypeDef#

# DescribeSchemaRequestRequestTypeDef definition

class DescribeSchemaRequestRequestTypeDef(TypedDict):
    schemaArn: str,

DescribeSolutionRequestRequestTypeDef#

# DescribeSolutionRequestRequestTypeDef definition

class DescribeSolutionRequestRequestTypeDef(TypedDict):
    solutionArn: str,

DescribeSolutionVersionRequestRequestTypeDef#

# DescribeSolutionVersionRequestRequestTypeDef definition

class DescribeSolutionVersionRequestRequestTypeDef(TypedDict):
    solutionVersionArn: str,

EventTrackerSummaryTypeDef#

# EventTrackerSummaryTypeDef definition

class EventTrackerSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    eventTrackerArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],

FieldsForThemeGenerationTypeDef#

# FieldsForThemeGenerationTypeDef definition

class FieldsForThemeGenerationTypeDef(TypedDict):
    itemName: str,

FilterSummaryTypeDef#

# FilterSummaryTypeDef definition

class FilterSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    filterArn: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    datasetGroupArn: NotRequired[str],
    failureReason: NotRequired[str],
    status: NotRequired[str],

GetSolutionMetricsRequestRequestTypeDef#

# GetSolutionMetricsRequestRequestTypeDef definition

class GetSolutionMetricsRequestRequestTypeDef(TypedDict):
    solutionVersionArn: str,

HPOObjectiveTypeDef#

# HPOObjectiveTypeDef definition

class HPOObjectiveTypeDef(TypedDict):
    type: NotRequired[str],
    metricName: NotRequired[str],
    metricRegex: NotRequired[str],

HPOResourceConfigTypeDef#

# HPOResourceConfigTypeDef definition

class HPOResourceConfigTypeDef(TypedDict):
    maxNumberOfTrainingJobs: NotRequired[str],
    maxParallelTrainingJobs: NotRequired[str],

IntegerHyperParameterRangeTypeDef#

# IntegerHyperParameterRangeTypeDef definition

class IntegerHyperParameterRangeTypeDef(TypedDict):
    name: NotRequired[str],
    minValue: NotRequired[int],
    maxValue: NotRequired[int],

PaginatorConfigTypeDef#

# PaginatorConfigTypeDef definition

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

ListBatchInferenceJobsRequestRequestTypeDef#

# ListBatchInferenceJobsRequestRequestTypeDef definition

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

ListBatchSegmentJobsRequestRequestTypeDef#

# ListBatchSegmentJobsRequestRequestTypeDef definition

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

ListCampaignsRequestRequestTypeDef#

# ListCampaignsRequestRequestTypeDef definition

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

ListDataDeletionJobsRequestRequestTypeDef#

# ListDataDeletionJobsRequestRequestTypeDef definition

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

ListDatasetExportJobsRequestRequestTypeDef#

# ListDatasetExportJobsRequestRequestTypeDef definition

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

ListDatasetGroupsRequestRequestTypeDef#

# ListDatasetGroupsRequestRequestTypeDef definition

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

ListDatasetImportJobsRequestRequestTypeDef#

# ListDatasetImportJobsRequestRequestTypeDef definition

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

ListDatasetsRequestRequestTypeDef#

# ListDatasetsRequestRequestTypeDef definition

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

ListEventTrackersRequestRequestTypeDef#

# ListEventTrackersRequestRequestTypeDef definition

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

ListFiltersRequestRequestTypeDef#

# ListFiltersRequestRequestTypeDef definition

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

ListMetricAttributionMetricsRequestRequestTypeDef#

# ListMetricAttributionMetricsRequestRequestTypeDef definition

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

ListMetricAttributionsRequestRequestTypeDef#

# ListMetricAttributionsRequestRequestTypeDef definition

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

MetricAttributionSummaryTypeDef#

# MetricAttributionSummaryTypeDef definition

class MetricAttributionSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    metricAttributionArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],

ListRecipesRequestRequestTypeDef#

# ListRecipesRequestRequestTypeDef definition

class ListRecipesRequestRequestTypeDef(TypedDict):
    recipeProvider: NotRequired[RecipeProviderType],  # (1)
    nextToken: NotRequired[str],
    maxResults: NotRequired[int],
    domain: NotRequired[DomainType],  # (2)
  1. See RecipeProviderType
  2. See DomainType

RecipeSummaryTypeDef#

# RecipeSummaryTypeDef definition

class RecipeSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    recipeArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    domain: NotRequired[DomainType],  # (1)
  1. See DomainType

ListRecommendersRequestRequestTypeDef#

# ListRecommendersRequestRequestTypeDef definition

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

ListSchemasRequestRequestTypeDef#

# ListSchemasRequestRequestTypeDef definition

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

ListSolutionVersionsRequestRequestTypeDef#

# ListSolutionVersionsRequestRequestTypeDef definition

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

SolutionVersionSummaryTypeDef#

# SolutionVersionSummaryTypeDef definition

class SolutionVersionSummaryTypeDef(TypedDict):
    solutionVersionArn: NotRequired[str],
    status: NotRequired[str],
    trainingMode: NotRequired[TrainingModeType],  # (1)
    trainingType: NotRequired[TrainingTypeType],  # (2)
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
  1. See TrainingModeType
  2. See TrainingTypeType

ListSolutionsRequestRequestTypeDef#

# ListSolutionsRequestRequestTypeDef definition

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

SolutionSummaryTypeDef#

# SolutionSummaryTypeDef definition

class SolutionSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    solutionArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    recipeArn: NotRequired[str],

ListTagsForResourceRequestRequestTypeDef#

# ListTagsForResourceRequestRequestTypeDef definition

class ListTagsForResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,

OptimizationObjectiveTypeDef#

# OptimizationObjectiveTypeDef definition

class OptimizationObjectiveTypeDef(TypedDict):
    itemAttribute: NotRequired[str],
    objectiveSensitivity: NotRequired[ObjectiveSensitivityType],  # (1)
  1. See ObjectiveSensitivityType

TrainingDataConfigOutputTypeDef#

# TrainingDataConfigOutputTypeDef definition

class TrainingDataConfigOutputTypeDef(TypedDict):
    excludedDatasetColumns: NotRequired[dict[str, list[str]]],

TunedHPOParamsTypeDef#

# TunedHPOParamsTypeDef definition

class TunedHPOParamsTypeDef(TypedDict):
    algorithmHyperParameters: NotRequired[dict[str, str]],

StartRecommenderRequestRequestTypeDef#

# StartRecommenderRequestRequestTypeDef definition

class StartRecommenderRequestRequestTypeDef(TypedDict):
    recommenderArn: str,

StopRecommenderRequestRequestTypeDef#

# StopRecommenderRequestRequestTypeDef definition

class StopRecommenderRequestRequestTypeDef(TypedDict):
    recommenderArn: str,

StopSolutionVersionCreationRequestRequestTypeDef#

# StopSolutionVersionCreationRequestRequestTypeDef definition

class StopSolutionVersionCreationRequestRequestTypeDef(TypedDict):
    solutionVersionArn: str,

TrainingDataConfigTypeDef#

# TrainingDataConfigTypeDef definition

class TrainingDataConfigTypeDef(TypedDict):
    excludedDatasetColumns: NotRequired[Mapping[str, Sequence[str]]],

UntagResourceRequestRequestTypeDef#

# UntagResourceRequestRequestTypeDef definition

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

UpdateDatasetRequestRequestTypeDef#

# UpdateDatasetRequestRequestTypeDef definition

class UpdateDatasetRequestRequestTypeDef(TypedDict):
    datasetArn: str,
    schemaArn: str,

SolutionUpdateConfigTypeDef#

# SolutionUpdateConfigTypeDef definition

class SolutionUpdateConfigTypeDef(TypedDict):
    autoTrainingConfig: NotRequired[AutoTrainingConfigTypeDef],  # (1)
  1. See AutoTrainingConfigTypeDef

BatchInferenceJobInputTypeDef#

# BatchInferenceJobInputTypeDef definition

class BatchInferenceJobInputTypeDef(TypedDict):
    s3DataSource: S3DataConfigTypeDef,  # (1)
  1. See S3DataConfigTypeDef

BatchInferenceJobOutputTypeDef#

# BatchInferenceJobOutputTypeDef definition

class BatchInferenceJobOutputTypeDef(TypedDict):
    s3DataDestination: S3DataConfigTypeDef,  # (1)
  1. See S3DataConfigTypeDef

BatchSegmentJobInputTypeDef#

# BatchSegmentJobInputTypeDef definition

class BatchSegmentJobInputTypeDef(TypedDict):
    s3DataSource: S3DataConfigTypeDef,  # (1)
  1. See S3DataConfigTypeDef

BatchSegmentJobOutputTypeDef#

# BatchSegmentJobOutputTypeDef definition

class BatchSegmentJobOutputTypeDef(TypedDict):
    s3DataDestination: S3DataConfigTypeDef,  # (1)
  1. See S3DataConfigTypeDef

DatasetExportJobOutputTypeDef#

# DatasetExportJobOutputTypeDef definition

class DatasetExportJobOutputTypeDef(TypedDict):
    s3DataDestination: S3DataConfigTypeDef,  # (1)
  1. See S3DataConfigTypeDef

MetricAttributionOutputTypeDef#

# MetricAttributionOutputTypeDef definition

class MetricAttributionOutputTypeDef(TypedDict):
    roleArn: str,
    s3DataDestination: NotRequired[S3DataConfigTypeDef],  # (1)
  1. See S3DataConfigTypeDef

CampaignUpdateSummaryTypeDef#

# CampaignUpdateSummaryTypeDef definition

class CampaignUpdateSummaryTypeDef(TypedDict):
    solutionVersionArn: NotRequired[str],
    minProvisionedTPS: NotRequired[int],
    campaignConfig: NotRequired[CampaignConfigOutputTypeDef],  # (1)
    status: NotRequired[str],
    failureReason: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
  1. See CampaignConfigOutputTypeDef

UpdateCampaignRequestRequestTypeDef#

# UpdateCampaignRequestRequestTypeDef definition

class UpdateCampaignRequestRequestTypeDef(TypedDict):
    campaignArn: str,
    solutionVersionArn: NotRequired[str],
    minProvisionedTPS: NotRequired[int],
    campaignConfig: NotRequired[CampaignConfigTypeDef],  # (1)
  1. See CampaignConfigTypeDef

CreateCampaignRequestRequestTypeDef#

# CreateCampaignRequestRequestTypeDef definition

class CreateCampaignRequestRequestTypeDef(TypedDict):
    name: str,
    solutionVersionArn: str,
    minProvisionedTPS: NotRequired[int],
    campaignConfig: NotRequired[CampaignConfigTypeDef],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See CampaignConfigTypeDef
  2. See TagTypeDef

CreateDatasetGroupRequestRequestTypeDef#

# CreateDatasetGroupRequestRequestTypeDef definition

class CreateDatasetGroupRequestRequestTypeDef(TypedDict):
    name: str,
    roleArn: NotRequired[str],
    kmsKeyArn: NotRequired[str],
    domain: NotRequired[DomainType],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See DomainType
  2. See TagTypeDef

CreateDatasetRequestRequestTypeDef#

# CreateDatasetRequestRequestTypeDef definition

class CreateDatasetRequestRequestTypeDef(TypedDict):
    name: str,
    schemaArn: str,
    datasetGroupArn: str,
    datasetType: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateEventTrackerRequestRequestTypeDef#

# CreateEventTrackerRequestRequestTypeDef definition

class CreateEventTrackerRequestRequestTypeDef(TypedDict):
    name: str,
    datasetGroupArn: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateFilterRequestRequestTypeDef#

# CreateFilterRequestRequestTypeDef definition

class CreateFilterRequestRequestTypeDef(TypedDict):
    name: str,
    datasetGroupArn: str,
    filterExpression: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (1)
  1. See TagTypeDef

CreateSolutionVersionRequestRequestTypeDef#

# CreateSolutionVersionRequestRequestTypeDef definition

class CreateSolutionVersionRequestRequestTypeDef(TypedDict):
    solutionArn: str,
    name: NotRequired[str],
    trainingMode: NotRequired[TrainingModeType],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See TrainingModeType
  2. See TagTypeDef

TagResourceRequestRequestTypeDef#

# TagResourceRequestRequestTypeDef definition

class TagResourceRequestRequestTypeDef(TypedDict):
    resourceArn: str,
    tags: Sequence[TagTypeDef],  # (1)
  1. See TagTypeDef

CreateBatchInferenceJobResponseTypeDef#

# CreateBatchInferenceJobResponseTypeDef definition

class CreateBatchInferenceJobResponseTypeDef(TypedDict):
    batchInferenceJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateBatchSegmentJobResponseTypeDef#

# CreateBatchSegmentJobResponseTypeDef definition

class CreateBatchSegmentJobResponseTypeDef(TypedDict):
    batchSegmentJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateCampaignResponseTypeDef#

# CreateCampaignResponseTypeDef definition

class CreateCampaignResponseTypeDef(TypedDict):
    campaignArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDataDeletionJobResponseTypeDef#

# CreateDataDeletionJobResponseTypeDef definition

class CreateDataDeletionJobResponseTypeDef(TypedDict):
    dataDeletionJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetExportJobResponseTypeDef#

# CreateDatasetExportJobResponseTypeDef definition

class CreateDatasetExportJobResponseTypeDef(TypedDict):
    datasetExportJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetGroupResponseTypeDef#

# CreateDatasetGroupResponseTypeDef definition

class CreateDatasetGroupResponseTypeDef(TypedDict):
    datasetGroupArn: str,
    domain: DomainType,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DomainType
  2. See ResponseMetadataTypeDef

CreateDatasetImportJobResponseTypeDef#

# CreateDatasetImportJobResponseTypeDef definition

class CreateDatasetImportJobResponseTypeDef(TypedDict):
    datasetImportJobArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDatasetResponseTypeDef#

# CreateDatasetResponseTypeDef definition

class CreateDatasetResponseTypeDef(TypedDict):
    datasetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateEventTrackerResponseTypeDef#

# CreateEventTrackerResponseTypeDef definition

class CreateEventTrackerResponseTypeDef(TypedDict):
    eventTrackerArn: str,
    trackingId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateFilterResponseTypeDef#

# CreateFilterResponseTypeDef definition

class CreateFilterResponseTypeDef(TypedDict):
    filterArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateMetricAttributionResponseTypeDef#

# CreateMetricAttributionResponseTypeDef definition

class CreateMetricAttributionResponseTypeDef(TypedDict):
    metricAttributionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateRecommenderResponseTypeDef#

# CreateRecommenderResponseTypeDef definition

class CreateRecommenderResponseTypeDef(TypedDict):
    recommenderArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSchemaResponseTypeDef#

# CreateSchemaResponseTypeDef definition

class CreateSchemaResponseTypeDef(TypedDict):
    schemaArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSolutionResponseTypeDef#

# CreateSolutionResponseTypeDef definition

class CreateSolutionResponseTypeDef(TypedDict):
    solutionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateSolutionVersionResponseTypeDef#

# CreateSolutionVersionResponseTypeDef definition

class CreateSolutionVersionResponseTypeDef(TypedDict):
    solutionVersionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

EmptyResponseMetadataTypeDef#

# EmptyResponseMetadataTypeDef definition

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

GetSolutionMetricsResponseTypeDef#

# GetSolutionMetricsResponseTypeDef definition

class GetSolutionMetricsResponseTypeDef(TypedDict):
    solutionVersionArn: str,
    metrics: dict[str, float],
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

ListBatchInferenceJobsResponseTypeDef#

# ListBatchInferenceJobsResponseTypeDef definition

class ListBatchInferenceJobsResponseTypeDef(TypedDict):
    batchInferenceJobs: list[BatchInferenceJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See BatchInferenceJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListBatchSegmentJobsResponseTypeDef#

# ListBatchSegmentJobsResponseTypeDef definition

class ListBatchSegmentJobsResponseTypeDef(TypedDict):
    batchSegmentJobs: list[BatchSegmentJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See BatchSegmentJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListCampaignsResponseTypeDef#

# ListCampaignsResponseTypeDef definition

class ListCampaignsResponseTypeDef(TypedDict):
    campaigns: list[CampaignSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See CampaignSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListTagsForResourceResponseTypeDef#

# ListTagsForResourceResponseTypeDef definition

class ListTagsForResourceResponseTypeDef(TypedDict):
    tags: list[TagTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See TagTypeDef
  2. See ResponseMetadataTypeDef

StartRecommenderResponseTypeDef#

# StartRecommenderResponseTypeDef definition

class StartRecommenderResponseTypeDef(TypedDict):
    recommenderArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

StopRecommenderResponseTypeDef#

# StopRecommenderResponseTypeDef definition

class StopRecommenderResponseTypeDef(TypedDict):
    recommenderArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateCampaignResponseTypeDef#

# UpdateCampaignResponseTypeDef definition

class UpdateCampaignResponseTypeDef(TypedDict):
    campaignArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateDatasetResponseTypeDef#

# UpdateDatasetResponseTypeDef definition

class UpdateDatasetResponseTypeDef(TypedDict):
    datasetArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateMetricAttributionResponseTypeDef#

# UpdateMetricAttributionResponseTypeDef definition

class UpdateMetricAttributionResponseTypeDef(TypedDict):
    metricAttributionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateRecommenderResponseTypeDef#

# UpdateRecommenderResponseTypeDef definition

class UpdateRecommenderResponseTypeDef(TypedDict):
    recommenderArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

UpdateSolutionResponseTypeDef#

# UpdateSolutionResponseTypeDef definition

class UpdateSolutionResponseTypeDef(TypedDict):
    solutionArn: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (1)
  1. See ResponseMetadataTypeDef

CreateDataDeletionJobRequestRequestTypeDef#

# CreateDataDeletionJobRequestRequestTypeDef definition

class CreateDataDeletionJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    datasetGroupArn: str,
    dataSource: DataSourceTypeDef,  # (1)
    roleArn: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See DataSourceTypeDef
  2. See TagTypeDef

CreateDatasetImportJobRequestRequestTypeDef#

# CreateDatasetImportJobRequestRequestTypeDef definition

class CreateDatasetImportJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    datasetArn: str,
    dataSource: DataSourceTypeDef,  # (1)
    roleArn: str,
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
    importMode: NotRequired[ImportModeType],  # (3)
    publishAttributionMetricsToS3: NotRequired[bool],
  1. See DataSourceTypeDef
  2. See TagTypeDef
  3. See ImportModeType

DataDeletionJobTypeDef#

# DataDeletionJobTypeDef definition

class DataDeletionJobTypeDef(TypedDict):
    jobName: NotRequired[str],
    dataDeletionJobArn: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    dataSource: NotRequired[DataSourceTypeDef],  # (1)
    roleArn: NotRequired[str],
    status: NotRequired[str],
    numDeleted: NotRequired[int],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
  1. See DataSourceTypeDef

DatasetImportJobTypeDef#

# DatasetImportJobTypeDef definition

class DatasetImportJobTypeDef(TypedDict):
    jobName: NotRequired[str],
    datasetImportJobArn: NotRequired[str],
    datasetArn: NotRequired[str],
    dataSource: NotRequired[DataSourceTypeDef],  # (1)
    roleArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
    importMode: NotRequired[ImportModeType],  # (2)
    publishAttributionMetricsToS3: NotRequired[bool],
  1. See DataSourceTypeDef
  2. See ImportModeType

ListMetricAttributionMetricsResponseTypeDef#

# ListMetricAttributionMetricsResponseTypeDef definition

class ListMetricAttributionMetricsResponseTypeDef(TypedDict):
    metrics: list[MetricAttributeTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See MetricAttributeTypeDef
  2. See ResponseMetadataTypeDef

ListDataDeletionJobsResponseTypeDef#

# ListDataDeletionJobsResponseTypeDef definition

class ListDataDeletionJobsResponseTypeDef(TypedDict):
    dataDeletionJobs: list[DataDeletionJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DataDeletionJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetExportJobsResponseTypeDef#

# ListDatasetExportJobsResponseTypeDef definition

class ListDatasetExportJobsResponseTypeDef(TypedDict):
    datasetExportJobs: list[DatasetExportJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DatasetExportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetGroupsResponseTypeDef#

# ListDatasetGroupsResponseTypeDef definition

class ListDatasetGroupsResponseTypeDef(TypedDict):
    datasetGroups: list[DatasetGroupSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DatasetGroupSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeDatasetGroupResponseTypeDef#

# DescribeDatasetGroupResponseTypeDef definition

class DescribeDatasetGroupResponseTypeDef(TypedDict):
    datasetGroup: DatasetGroupTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetGroupTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetImportJobsResponseTypeDef#

# ListDatasetImportJobsResponseTypeDef definition

class ListDatasetImportJobsResponseTypeDef(TypedDict):
    datasetImportJobs: list[DatasetImportJobSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DatasetImportJobSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSchemasResponseTypeDef#

# ListSchemasResponseTypeDef definition

class ListSchemasResponseTypeDef(TypedDict):
    schemas: list[DatasetSchemaSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DatasetSchemaSummaryTypeDef
  2. See ResponseMetadataTypeDef

DescribeSchemaResponseTypeDef#

# DescribeSchemaResponseTypeDef definition

class DescribeSchemaResponseTypeDef(TypedDict):
    schema: DatasetSchemaTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetSchemaTypeDef
  2. See ResponseMetadataTypeDef

ListDatasetsResponseTypeDef#

# ListDatasetsResponseTypeDef definition

class ListDatasetsResponseTypeDef(TypedDict):
    datasets: list[DatasetSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See DatasetSummaryTypeDef
  2. See ResponseMetadataTypeDef

DatasetTypeDef#

# DatasetTypeDef definition

class DatasetTypeDef(TypedDict):
    name: NotRequired[str],
    datasetArn: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    datasetType: NotRequired[str],
    schemaArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    latestDatasetUpdate: NotRequired[DatasetUpdateSummaryTypeDef],  # (1)
    trackingId: NotRequired[str],
  1. See DatasetUpdateSummaryTypeDef

DefaultHyperParameterRangesTypeDef#

# DefaultHyperParameterRangesTypeDef definition

class DefaultHyperParameterRangesTypeDef(TypedDict):
    integerHyperParameterRanges: NotRequired[list[DefaultIntegerHyperParameterRangeTypeDef]],  # (1)
    continuousHyperParameterRanges: NotRequired[list[DefaultContinuousHyperParameterRangeTypeDef]],  # (2)
    categoricalHyperParameterRanges: NotRequired[list[DefaultCategoricalHyperParameterRangeTypeDef]],  # (3)
  1. See DefaultIntegerHyperParameterRangeTypeDef
  2. See DefaultContinuousHyperParameterRangeTypeDef
  3. See DefaultCategoricalHyperParameterRangeTypeDef

DescribeEventTrackerResponseTypeDef#

# DescribeEventTrackerResponseTypeDef definition

class DescribeEventTrackerResponseTypeDef(TypedDict):
    eventTracker: EventTrackerTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See EventTrackerTypeDef
  2. See ResponseMetadataTypeDef

DescribeFeatureTransformationResponseTypeDef#

# DescribeFeatureTransformationResponseTypeDef definition

class DescribeFeatureTransformationResponseTypeDef(TypedDict):
    featureTransformation: FeatureTransformationTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FeatureTransformationTypeDef
  2. See ResponseMetadataTypeDef

DescribeFilterResponseTypeDef#

# DescribeFilterResponseTypeDef definition

class DescribeFilterResponseTypeDef(TypedDict):
    filter: FilterTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See FilterTypeDef
  2. See ResponseMetadataTypeDef

DescribeRecipeResponseTypeDef#

# DescribeRecipeResponseTypeDef definition

class DescribeRecipeResponseTypeDef(TypedDict):
    recipe: RecipeTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecipeTypeDef
  2. See ResponseMetadataTypeDef

ListEventTrackersResponseTypeDef#

# ListEventTrackersResponseTypeDef definition

class ListEventTrackersResponseTypeDef(TypedDict):
    eventTrackers: list[EventTrackerSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See EventTrackerSummaryTypeDef
  2. See ResponseMetadataTypeDef

ThemeGenerationConfigTypeDef#

# ThemeGenerationConfigTypeDef definition

class ThemeGenerationConfigTypeDef(TypedDict):
    fieldsForThemeGeneration: FieldsForThemeGenerationTypeDef,  # (1)
  1. See FieldsForThemeGenerationTypeDef

ListFiltersResponseTypeDef#

# ListFiltersResponseTypeDef definition

class ListFiltersResponseTypeDef(TypedDict):
    Filters: list[FilterSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See FilterSummaryTypeDef
  2. See ResponseMetadataTypeDef

HyperParameterRangesOutputTypeDef#

# HyperParameterRangesOutputTypeDef definition

class HyperParameterRangesOutputTypeDef(TypedDict):
    integerHyperParameterRanges: NotRequired[list[IntegerHyperParameterRangeTypeDef]],  # (1)
    continuousHyperParameterRanges: NotRequired[list[ContinuousHyperParameterRangeTypeDef]],  # (2)
    categoricalHyperParameterRanges: NotRequired[list[CategoricalHyperParameterRangeOutputTypeDef]],  # (3)
  1. See IntegerHyperParameterRangeTypeDef
  2. See ContinuousHyperParameterRangeTypeDef
  3. See CategoricalHyperParameterRangeOutputTypeDef

ListBatchInferenceJobsRequestPaginateTypeDef#

# ListBatchInferenceJobsRequestPaginateTypeDef definition

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

ListBatchSegmentJobsRequestPaginateTypeDef#

# ListBatchSegmentJobsRequestPaginateTypeDef definition

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

ListCampaignsRequestPaginateTypeDef#

# ListCampaignsRequestPaginateTypeDef definition

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

ListDatasetExportJobsRequestPaginateTypeDef#

# ListDatasetExportJobsRequestPaginateTypeDef definition

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

ListDatasetGroupsRequestPaginateTypeDef#

# ListDatasetGroupsRequestPaginateTypeDef definition

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

ListDatasetImportJobsRequestPaginateTypeDef#

# ListDatasetImportJobsRequestPaginateTypeDef definition

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

ListDatasetsRequestPaginateTypeDef#

# ListDatasetsRequestPaginateTypeDef definition

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

ListEventTrackersRequestPaginateTypeDef#

# ListEventTrackersRequestPaginateTypeDef definition

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

ListFiltersRequestPaginateTypeDef#

# ListFiltersRequestPaginateTypeDef definition

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

ListMetricAttributionMetricsRequestPaginateTypeDef#

# ListMetricAttributionMetricsRequestPaginateTypeDef definition

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

ListMetricAttributionsRequestPaginateTypeDef#

# ListMetricAttributionsRequestPaginateTypeDef definition

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

ListRecipesRequestPaginateTypeDef#

# ListRecipesRequestPaginateTypeDef definition

class ListRecipesRequestPaginateTypeDef(TypedDict):
    recipeProvider: NotRequired[RecipeProviderType],  # (1)
    domain: NotRequired[DomainType],  # (2)
    PaginationConfig: NotRequired[PaginatorConfigTypeDef],  # (3)
  1. See RecipeProviderType
  2. See DomainType
  3. See PaginatorConfigTypeDef

ListRecommendersRequestPaginateTypeDef#

# ListRecommendersRequestPaginateTypeDef definition

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

ListSchemasRequestPaginateTypeDef#

# ListSchemasRequestPaginateTypeDef definition

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

ListSolutionVersionsRequestPaginateTypeDef#

# ListSolutionVersionsRequestPaginateTypeDef definition

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

ListSolutionsRequestPaginateTypeDef#

# ListSolutionsRequestPaginateTypeDef definition

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

ListMetricAttributionsResponseTypeDef#

# ListMetricAttributionsResponseTypeDef definition

class ListMetricAttributionsResponseTypeDef(TypedDict):
    metricAttributions: list[MetricAttributionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See MetricAttributionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListRecipesResponseTypeDef#

# ListRecipesResponseTypeDef definition

class ListRecipesResponseTypeDef(TypedDict):
    recipes: list[RecipeSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See RecipeSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSolutionVersionsResponseTypeDef#

# ListSolutionVersionsResponseTypeDef definition

class ListSolutionVersionsResponseTypeDef(TypedDict):
    solutionVersions: list[SolutionVersionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See SolutionVersionSummaryTypeDef
  2. See ResponseMetadataTypeDef

ListSolutionsResponseTypeDef#

# ListSolutionsResponseTypeDef definition

class ListSolutionsResponseTypeDef(TypedDict):
    solutions: list[SolutionSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See SolutionSummaryTypeDef
  2. See ResponseMetadataTypeDef

RecommenderConfigOutputTypeDef#

# RecommenderConfigOutputTypeDef definition

class RecommenderConfigOutputTypeDef(TypedDict):
    itemExplorationConfig: NotRequired[dict[str, str]],
    minRecommendationRequestsPerSecond: NotRequired[int],
    trainingDataConfig: NotRequired[TrainingDataConfigOutputTypeDef],  # (1)
    enableMetadataWithRecommendations: NotRequired[bool],
  1. See TrainingDataConfigOutputTypeDef

SolutionUpdateSummaryTypeDef#

# SolutionUpdateSummaryTypeDef definition

class SolutionUpdateSummaryTypeDef(TypedDict):
    solutionUpdateConfig: NotRequired[SolutionUpdateConfigTypeDef],  # (1)
    status: NotRequired[str],
    performAutoTraining: NotRequired[bool],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
  1. See SolutionUpdateConfigTypeDef

UpdateSolutionRequestRequestTypeDef#

# UpdateSolutionRequestRequestTypeDef definition

class UpdateSolutionRequestRequestTypeDef(TypedDict):
    solutionArn: str,
    performAutoTraining: NotRequired[bool],
    solutionUpdateConfig: NotRequired[SolutionUpdateConfigTypeDef],  # (1)
  1. See SolutionUpdateConfigTypeDef

BatchSegmentJobTypeDef#

# BatchSegmentJobTypeDef definition

class BatchSegmentJobTypeDef(TypedDict):
    jobName: NotRequired[str],
    batchSegmentJobArn: NotRequired[str],
    filterArn: NotRequired[str],
    failureReason: NotRequired[str],
    solutionVersionArn: NotRequired[str],
    numResults: NotRequired[int],
    jobInput: NotRequired[BatchSegmentJobInputTypeDef],  # (1)
    jobOutput: NotRequired[BatchSegmentJobOutputTypeDef],  # (2)
    roleArn: NotRequired[str],
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
  1. See BatchSegmentJobInputTypeDef
  2. See BatchSegmentJobOutputTypeDef

CreateBatchSegmentJobRequestRequestTypeDef#

# CreateBatchSegmentJobRequestRequestTypeDef definition

class CreateBatchSegmentJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    solutionVersionArn: str,
    jobInput: BatchSegmentJobInputTypeDef,  # (1)
    jobOutput: BatchSegmentJobOutputTypeDef,  # (2)
    roleArn: str,
    filterArn: NotRequired[str],
    numResults: NotRequired[int],
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See BatchSegmentJobInputTypeDef
  2. See BatchSegmentJobOutputTypeDef
  3. See TagTypeDef

CreateDatasetExportJobRequestRequestTypeDef#

# CreateDatasetExportJobRequestRequestTypeDef definition

class CreateDatasetExportJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    datasetArn: str,
    roleArn: str,
    jobOutput: DatasetExportJobOutputTypeDef,  # (1)
    ingestionMode: NotRequired[IngestionModeType],  # (2)
    tags: NotRequired[Sequence[TagTypeDef]],  # (3)
  1. See DatasetExportJobOutputTypeDef
  2. See IngestionModeType
  3. See TagTypeDef

DatasetExportJobTypeDef#

# DatasetExportJobTypeDef definition

class DatasetExportJobTypeDef(TypedDict):
    jobName: NotRequired[str],
    datasetExportJobArn: NotRequired[str],
    datasetArn: NotRequired[str],
    ingestionMode: NotRequired[IngestionModeType],  # (1)
    roleArn: NotRequired[str],
    status: NotRequired[str],
    jobOutput: NotRequired[DatasetExportJobOutputTypeDef],  # (2)
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
  1. See IngestionModeType
  2. See DatasetExportJobOutputTypeDef

CreateMetricAttributionRequestRequestTypeDef#

# CreateMetricAttributionRequestRequestTypeDef definition

class CreateMetricAttributionRequestRequestTypeDef(TypedDict):
    name: str,
    datasetGroupArn: str,
    metrics: Sequence[MetricAttributeTypeDef],  # (1)
    metricsOutputConfig: MetricAttributionOutputTypeDef,  # (2)
  1. See MetricAttributeTypeDef
  2. See MetricAttributionOutputTypeDef

MetricAttributionTypeDef#

# MetricAttributionTypeDef definition

class MetricAttributionTypeDef(TypedDict):
    name: NotRequired[str],
    metricAttributionArn: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    metricsOutputConfig: NotRequired[MetricAttributionOutputTypeDef],  # (1)
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    failureReason: NotRequired[str],
  1. See MetricAttributionOutputTypeDef

UpdateMetricAttributionRequestRequestTypeDef#

# UpdateMetricAttributionRequestRequestTypeDef definition

class UpdateMetricAttributionRequestRequestTypeDef(TypedDict):
    addMetrics: NotRequired[Sequence[MetricAttributeTypeDef]],  # (1)
    removeMetrics: NotRequired[Sequence[str]],
    metricsOutputConfig: NotRequired[MetricAttributionOutputTypeDef],  # (2)
    metricAttributionArn: NotRequired[str],
  1. See MetricAttributeTypeDef
  2. See MetricAttributionOutputTypeDef

CampaignTypeDef#

# CampaignTypeDef definition

class CampaignTypeDef(TypedDict):
    name: NotRequired[str],
    campaignArn: NotRequired[str],
    solutionVersionArn: NotRequired[str],
    minProvisionedTPS: NotRequired[int],
    campaignConfig: NotRequired[CampaignConfigOutputTypeDef],  # (1)
    status: NotRequired[str],
    failureReason: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    latestCampaignUpdate: NotRequired[CampaignUpdateSummaryTypeDef],  # (2)
  1. See CampaignConfigOutputTypeDef
  2. See CampaignUpdateSummaryTypeDef

HyperParameterRangesTypeDef#

# HyperParameterRangesTypeDef definition

class HyperParameterRangesTypeDef(TypedDict):
    integerHyperParameterRanges: NotRequired[Sequence[IntegerHyperParameterRangeTypeDef]],  # (1)
    continuousHyperParameterRanges: NotRequired[Sequence[ContinuousHyperParameterRangeTypeDef]],  # (2)
    categoricalHyperParameterRanges: NotRequired[Sequence[CategoricalHyperParameterRangeUnionTypeDef]],  # (3)
  1. See IntegerHyperParameterRangeTypeDef
  2. See ContinuousHyperParameterRangeTypeDef
  3. See CategoricalHyperParameterRangeTypeDef CategoricalHyperParameterRangeOutputTypeDef

DescribeDataDeletionJobResponseTypeDef#

# DescribeDataDeletionJobResponseTypeDef definition

class DescribeDataDeletionJobResponseTypeDef(TypedDict):
    dataDeletionJob: DataDeletionJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DataDeletionJobTypeDef
  2. See ResponseMetadataTypeDef

DescribeDatasetImportJobResponseTypeDef#

# DescribeDatasetImportJobResponseTypeDef definition

class DescribeDatasetImportJobResponseTypeDef(TypedDict):
    datasetImportJob: DatasetImportJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetImportJobTypeDef
  2. See ResponseMetadataTypeDef

DescribeDatasetResponseTypeDef#

# DescribeDatasetResponseTypeDef definition

class DescribeDatasetResponseTypeDef(TypedDict):
    dataset: DatasetTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetTypeDef
  2. See ResponseMetadataTypeDef

AlgorithmTypeDef#

# AlgorithmTypeDef definition

class AlgorithmTypeDef(TypedDict):
    name: NotRequired[str],
    algorithmArn: NotRequired[str],
    algorithmImage: NotRequired[AlgorithmImageTypeDef],  # (1)
    defaultHyperParameters: NotRequired[dict[str, str]],
    defaultHyperParameterRanges: NotRequired[DefaultHyperParameterRangesTypeDef],  # (2)
    defaultResourceConfig: NotRequired[dict[str, str]],
    trainingInputMode: NotRequired[str],
    roleArn: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
  1. See AlgorithmImageTypeDef
  2. See DefaultHyperParameterRangesTypeDef

BatchInferenceJobTypeDef#

# BatchInferenceJobTypeDef definition

class BatchInferenceJobTypeDef(TypedDict):
    jobName: NotRequired[str],
    batchInferenceJobArn: NotRequired[str],
    filterArn: NotRequired[str],
    failureReason: NotRequired[str],
    solutionVersionArn: NotRequired[str],
    numResults: NotRequired[int],
    jobInput: NotRequired[BatchInferenceJobInputTypeDef],  # (1)
    jobOutput: NotRequired[BatchInferenceJobOutputTypeDef],  # (2)
    batchInferenceJobConfig: NotRequired[BatchInferenceJobConfigOutputTypeDef],  # (3)
    roleArn: NotRequired[str],
    batchInferenceJobMode: NotRequired[BatchInferenceJobModeType],  # (4)
    themeGenerationConfig: NotRequired[ThemeGenerationConfigTypeDef],  # (5)
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
  1. See BatchInferenceJobInputTypeDef
  2. See BatchInferenceJobOutputTypeDef
  3. See BatchInferenceJobConfigOutputTypeDef
  4. See BatchInferenceJobModeType
  5. See ThemeGenerationConfigTypeDef

CreateBatchInferenceJobRequestRequestTypeDef#

# CreateBatchInferenceJobRequestRequestTypeDef definition

class CreateBatchInferenceJobRequestRequestTypeDef(TypedDict):
    jobName: str,
    solutionVersionArn: str,
    jobInput: BatchInferenceJobInputTypeDef,  # (1)
    jobOutput: BatchInferenceJobOutputTypeDef,  # (2)
    roleArn: str,
    filterArn: NotRequired[str],
    numResults: NotRequired[int],
    batchInferenceJobConfig: NotRequired[BatchInferenceJobConfigTypeDef],  # (3)
    tags: NotRequired[Sequence[TagTypeDef]],  # (4)
    batchInferenceJobMode: NotRequired[BatchInferenceJobModeType],  # (5)
    themeGenerationConfig: NotRequired[ThemeGenerationConfigTypeDef],  # (6)
  1. See BatchInferenceJobInputTypeDef
  2. See BatchInferenceJobOutputTypeDef
  3. See BatchInferenceJobConfigTypeDef
  4. See TagTypeDef
  5. See BatchInferenceJobModeType
  6. See ThemeGenerationConfigTypeDef

HPOConfigOutputTypeDef#

# HPOConfigOutputTypeDef definition

class HPOConfigOutputTypeDef(TypedDict):
    hpoObjective: NotRequired[HPOObjectiveTypeDef],  # (1)
    hpoResourceConfig: NotRequired[HPOResourceConfigTypeDef],  # (2)
    algorithmHyperParameterRanges: NotRequired[HyperParameterRangesOutputTypeDef],  # (3)
  1. See HPOObjectiveTypeDef
  2. See HPOResourceConfigTypeDef
  3. See HyperParameterRangesOutputTypeDef

RecommenderSummaryTypeDef#

# RecommenderSummaryTypeDef definition

class RecommenderSummaryTypeDef(TypedDict):
    name: NotRequired[str],
    recommenderArn: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    recipeArn: NotRequired[str],
    recommenderConfig: NotRequired[RecommenderConfigOutputTypeDef],  # (1)
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
  1. See RecommenderConfigOutputTypeDef

RecommenderUpdateSummaryTypeDef#

# RecommenderUpdateSummaryTypeDef definition

class RecommenderUpdateSummaryTypeDef(TypedDict):
    recommenderConfig: NotRequired[RecommenderConfigOutputTypeDef],  # (1)
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    status: NotRequired[str],
    failureReason: NotRequired[str],
  1. See RecommenderConfigOutputTypeDef

RecommenderConfigTypeDef#

# RecommenderConfigTypeDef definition

class RecommenderConfigTypeDef(TypedDict):
    itemExplorationConfig: NotRequired[Mapping[str, str]],
    minRecommendationRequestsPerSecond: NotRequired[int],
    trainingDataConfig: NotRequired[TrainingDataConfigUnionTypeDef],  # (1)
    enableMetadataWithRecommendations: NotRequired[bool],
  1. See TrainingDataConfigTypeDef TrainingDataConfigOutputTypeDef

DescribeBatchSegmentJobResponseTypeDef#

# DescribeBatchSegmentJobResponseTypeDef definition

class DescribeBatchSegmentJobResponseTypeDef(TypedDict):
    batchSegmentJob: BatchSegmentJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchSegmentJobTypeDef
  2. See ResponseMetadataTypeDef

DescribeDatasetExportJobResponseTypeDef#

# DescribeDatasetExportJobResponseTypeDef definition

class DescribeDatasetExportJobResponseTypeDef(TypedDict):
    datasetExportJob: DatasetExportJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See DatasetExportJobTypeDef
  2. See ResponseMetadataTypeDef

DescribeMetricAttributionResponseTypeDef#

# DescribeMetricAttributionResponseTypeDef definition

class DescribeMetricAttributionResponseTypeDef(TypedDict):
    metricAttribution: MetricAttributionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See MetricAttributionTypeDef
  2. See ResponseMetadataTypeDef

DescribeCampaignResponseTypeDef#

# DescribeCampaignResponseTypeDef definition

class DescribeCampaignResponseTypeDef(TypedDict):
    campaign: CampaignTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See CampaignTypeDef
  2. See ResponseMetadataTypeDef

DescribeAlgorithmResponseTypeDef#

# DescribeAlgorithmResponseTypeDef definition

class DescribeAlgorithmResponseTypeDef(TypedDict):
    algorithm: AlgorithmTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See AlgorithmTypeDef
  2. See ResponseMetadataTypeDef

DescribeBatchInferenceJobResponseTypeDef#

# DescribeBatchInferenceJobResponseTypeDef definition

class DescribeBatchInferenceJobResponseTypeDef(TypedDict):
    batchInferenceJob: BatchInferenceJobTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See BatchInferenceJobTypeDef
  2. See ResponseMetadataTypeDef

SolutionConfigOutputTypeDef#

# SolutionConfigOutputTypeDef definition

class SolutionConfigOutputTypeDef(TypedDict):
    eventValueThreshold: NotRequired[str],
    hpoConfig: NotRequired[HPOConfigOutputTypeDef],  # (1)
    algorithmHyperParameters: NotRequired[dict[str, str]],
    featureTransformationParameters: NotRequired[dict[str, str]],
    autoMLConfig: NotRequired[AutoMLConfigOutputTypeDef],  # (2)
    optimizationObjective: NotRequired[OptimizationObjectiveTypeDef],  # (3)
    trainingDataConfig: NotRequired[TrainingDataConfigOutputTypeDef],  # (4)
    autoTrainingConfig: NotRequired[AutoTrainingConfigTypeDef],  # (5)
  1. See HPOConfigOutputTypeDef
  2. See AutoMLConfigOutputTypeDef
  3. See OptimizationObjectiveTypeDef
  4. See TrainingDataConfigOutputTypeDef
  5. See AutoTrainingConfigTypeDef

ListRecommendersResponseTypeDef#

# ListRecommendersResponseTypeDef definition

class ListRecommendersResponseTypeDef(TypedDict):
    recommenders: list[RecommenderSummaryTypeDef],  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
    nextToken: NotRequired[str],
  1. See RecommenderSummaryTypeDef
  2. See ResponseMetadataTypeDef

RecommenderTypeDef#

# RecommenderTypeDef definition

class RecommenderTypeDef(TypedDict):
    recommenderArn: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    name: NotRequired[str],
    recipeArn: NotRequired[str],
    recommenderConfig: NotRequired[RecommenderConfigOutputTypeDef],  # (1)
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    status: NotRequired[str],
    failureReason: NotRequired[str],
    latestRecommenderUpdate: NotRequired[RecommenderUpdateSummaryTypeDef],  # (2)
    modelMetrics: NotRequired[dict[str, float]],
  1. See RecommenderConfigOutputTypeDef
  2. See RecommenderUpdateSummaryTypeDef

CreateRecommenderRequestRequestTypeDef#

# CreateRecommenderRequestRequestTypeDef definition

class CreateRecommenderRequestRequestTypeDef(TypedDict):
    name: str,
    datasetGroupArn: str,
    recipeArn: str,
    recommenderConfig: NotRequired[RecommenderConfigTypeDef],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See RecommenderConfigTypeDef
  2. See TagTypeDef

UpdateRecommenderRequestRequestTypeDef#

# UpdateRecommenderRequestRequestTypeDef definition

class UpdateRecommenderRequestRequestTypeDef(TypedDict):
    recommenderArn: str,
    recommenderConfig: RecommenderConfigTypeDef,  # (1)
  1. See RecommenderConfigTypeDef

HPOConfigTypeDef#

# HPOConfigTypeDef definition

class HPOConfigTypeDef(TypedDict):
    hpoObjective: NotRequired[HPOObjectiveTypeDef],  # (1)
    hpoResourceConfig: NotRequired[HPOResourceConfigTypeDef],  # (2)
    algorithmHyperParameterRanges: NotRequired[HyperParameterRangesUnionTypeDef],  # (3)
  1. See HPOObjectiveTypeDef
  2. See HPOResourceConfigTypeDef
  3. See HyperParameterRangesTypeDef HyperParameterRangesOutputTypeDef

SolutionTypeDef#

# SolutionTypeDef definition

class SolutionTypeDef(TypedDict):
    name: NotRequired[str],
    solutionArn: NotRequired[str],
    performHPO: NotRequired[bool],
    performAutoML: NotRequired[bool],
    performAutoTraining: NotRequired[bool],
    recipeArn: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    eventType: NotRequired[str],
    solutionConfig: NotRequired[SolutionConfigOutputTypeDef],  # (1)
    autoMLResult: NotRequired[AutoMLResultTypeDef],  # (2)
    status: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    latestSolutionVersion: NotRequired[SolutionVersionSummaryTypeDef],  # (3)
    latestSolutionUpdate: NotRequired[SolutionUpdateSummaryTypeDef],  # (4)
  1. See SolutionConfigOutputTypeDef
  2. See AutoMLResultTypeDef
  3. See SolutionVersionSummaryTypeDef
  4. See SolutionUpdateSummaryTypeDef

SolutionVersionTypeDef#

# SolutionVersionTypeDef definition

class SolutionVersionTypeDef(TypedDict):
    name: NotRequired[str],
    solutionVersionArn: NotRequired[str],
    solutionArn: NotRequired[str],
    performHPO: NotRequired[bool],
    performAutoML: NotRequired[bool],
    recipeArn: NotRequired[str],
    eventType: NotRequired[str],
    datasetGroupArn: NotRequired[str],
    solutionConfig: NotRequired[SolutionConfigOutputTypeDef],  # (1)
    trainingHours: NotRequired[float],
    trainingMode: NotRequired[TrainingModeType],  # (2)
    tunedHPOParams: NotRequired[TunedHPOParamsTypeDef],  # (3)
    status: NotRequired[str],
    failureReason: NotRequired[str],
    creationDateTime: NotRequired[datetime],
    lastUpdatedDateTime: NotRequired[datetime],
    trainingType: NotRequired[TrainingTypeType],  # (4)
  1. See SolutionConfigOutputTypeDef
  2. See TrainingModeType
  3. See TunedHPOParamsTypeDef
  4. See TrainingTypeType

DescribeRecommenderResponseTypeDef#

# DescribeRecommenderResponseTypeDef definition

class DescribeRecommenderResponseTypeDef(TypedDict):
    recommender: RecommenderTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See RecommenderTypeDef
  2. See ResponseMetadataTypeDef

DescribeSolutionResponseTypeDef#

# DescribeSolutionResponseTypeDef definition

class DescribeSolutionResponseTypeDef(TypedDict):
    solution: SolutionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SolutionTypeDef
  2. See ResponseMetadataTypeDef

DescribeSolutionVersionResponseTypeDef#

# DescribeSolutionVersionResponseTypeDef definition

class DescribeSolutionVersionResponseTypeDef(TypedDict):
    solutionVersion: SolutionVersionTypeDef,  # (1)
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)
  1. See SolutionVersionTypeDef
  2. See ResponseMetadataTypeDef

SolutionConfigTypeDef#

# SolutionConfigTypeDef definition

class SolutionConfigTypeDef(TypedDict):
    eventValueThreshold: NotRequired[str],
    hpoConfig: NotRequired[HPOConfigUnionTypeDef],  # (1)
    algorithmHyperParameters: NotRequired[Mapping[str, str]],
    featureTransformationParameters: NotRequired[Mapping[str, str]],
    autoMLConfig: NotRequired[AutoMLConfigUnionTypeDef],  # (2)
    optimizationObjective: NotRequired[OptimizationObjectiveTypeDef],  # (3)
    trainingDataConfig: NotRequired[TrainingDataConfigUnionTypeDef],  # (4)
    autoTrainingConfig: NotRequired[AutoTrainingConfigTypeDef],  # (5)
  1. See HPOConfigTypeDef HPOConfigOutputTypeDef
  2. See AutoMLConfigTypeDef AutoMLConfigOutputTypeDef
  3. See OptimizationObjectiveTypeDef
  4. See TrainingDataConfigTypeDef TrainingDataConfigOutputTypeDef
  5. See AutoTrainingConfigTypeDef

CreateSolutionRequestRequestTypeDef#

# CreateSolutionRequestRequestTypeDef definition

class CreateSolutionRequestRequestTypeDef(TypedDict):
    name: str,
    datasetGroupArn: str,
    performHPO: NotRequired[bool],
    performAutoML: NotRequired[bool],
    performAutoTraining: NotRequired[bool],
    recipeArn: NotRequired[str],
    eventType: NotRequired[str],
    solutionConfig: NotRequired[SolutionConfigTypeDef],  # (1)
    tags: NotRequired[Sequence[TagTypeDef]],  # (2)
  1. See SolutionConfigTypeDef
  2. See TagTypeDef