Typed dictionaries
Index > Personalize > Typed dictionaries
Auto-generated documentation for Personalize type annotations stubs module mypy-boto3-personalize.
AlgorithmImageTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import AlgorithmImageTypeDef
def get_value() -> AlgorithmImageTypeDef:
return {
"dockerURI": ...,
}
AutoMLConfigTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import AutoMLConfigTypeDef
def get_value() -> AutoMLConfigTypeDef:
return {
"metricName": ...,
}
Definition
class AutoMLConfigTypeDef(TypedDict):
metricName: NotRequired[str],
recipeList: NotRequired[Sequence[str]],
AutoMLResultTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import AutoMLResultTypeDef
def get_value() -> AutoMLResultTypeDef:
return {
"bestRecipeArn": ...,
}
BatchInferenceJobConfigTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import BatchInferenceJobConfigTypeDef
def get_value() -> BatchInferenceJobConfigTypeDef:
return {
"itemExplorationConfig": ...,
}
Definition
class BatchInferenceJobConfigTypeDef(TypedDict):
itemExplorationConfig: NotRequired[Mapping[str, str]],
S3DataConfigTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import S3DataConfigTypeDef
def get_value() -> S3DataConfigTypeDef:
return {
"path": ...,
}
BatchInferenceJobSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import BatchInferenceJobSummaryTypeDef
def get_value() -> BatchInferenceJobSummaryTypeDef:
return {
"batchInferenceJobArn": ...,
}
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],
BatchSegmentJobSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import BatchSegmentJobSummaryTypeDef
def get_value() -> BatchSegmentJobSummaryTypeDef:
return {
"batchSegmentJobArn": ...,
}
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],
CampaignConfigTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CampaignConfigTypeDef
def get_value() -> CampaignConfigTypeDef:
return {
"itemExplorationConfig": ...,
}
Definition
class CampaignConfigTypeDef(TypedDict):
itemExplorationConfig: NotRequired[Mapping[str, str]],
CampaignSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CampaignSummaryTypeDef
def get_value() -> CampaignSummaryTypeDef:
return {
"name": ...,
}
Definition
class CampaignSummaryTypeDef(TypedDict):
name: NotRequired[str],
campaignArn: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
failureReason: NotRequired[str],
CategoricalHyperParameterRangeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CategoricalHyperParameterRangeTypeDef
def get_value() -> CategoricalHyperParameterRangeTypeDef:
return {
"name": ...,
}
Definition
class CategoricalHyperParameterRangeTypeDef(TypedDict):
name: NotRequired[str],
values: NotRequired[Sequence[str]],
ContinuousHyperParameterRangeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ContinuousHyperParameterRangeTypeDef
def get_value() -> ContinuousHyperParameterRangeTypeDef:
return {
"name": ...,
}
Definition
class ContinuousHyperParameterRangeTypeDef(TypedDict):
name: NotRequired[str],
minValue: NotRequired[float],
maxValue: NotRequired[float],
TagTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import TagTypeDef
def get_value() -> TagTypeDef:
return {
"tagKey": ...,
"tagValue": ...,
}
ResponseMetadataTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
"HostId": ...,
"HTTPStatusCode": ...,
"HTTPHeaders": ...,
"RetryAttempts": ...,
}
Definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HostId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
DataSourceTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DataSourceTypeDef
def get_value() -> DataSourceTypeDef:
return {
"dataLocation": ...,
}
MetricAttributeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import MetricAttributeTypeDef
def get_value() -> MetricAttributeTypeDef:
return {
"eventType": ...,
"metricName": ...,
"expression": ...,
}
Definition
class MetricAttributeTypeDef(TypedDict):
eventType: str,
metricName: str,
expression: str,
RecommenderConfigTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import RecommenderConfigTypeDef
def get_value() -> RecommenderConfigTypeDef:
return {
"itemExplorationConfig": ...,
}
Definition
class RecommenderConfigTypeDef(TypedDict):
itemExplorationConfig: NotRequired[Mapping[str, str]],
minRecommendationRequestsPerSecond: NotRequired[int],
CreateSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateSchemaRequestRequestTypeDef
def get_value() -> CreateSchemaRequestRequestTypeDef:
return {
"name": ...,
"schema": ...,
}
Definition
class CreateSchemaRequestRequestTypeDef(TypedDict):
name: str,
schema: str,
domain: NotRequired[DomainType], # (1)
- See DomainType
DatasetExportJobSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetExportJobSummaryTypeDef
def get_value() -> DatasetExportJobSummaryTypeDef:
return {
"datasetExportJobArn": ...,
}
Definition
class DatasetExportJobSummaryTypeDef(TypedDict):
datasetExportJobArn: NotRequired[str],
jobName: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
failureReason: NotRequired[str],
DatasetGroupSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetGroupSummaryTypeDef
def get_value() -> DatasetGroupSummaryTypeDef:
return {
"name": ...,
}
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)
- See DomainType
DatasetGroupTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetGroupTypeDef
def get_value() -> DatasetGroupTypeDef:
return {
"name": ...,
}
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)
- See DomainType
DatasetImportJobSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetImportJobSummaryTypeDef
def get_value() -> DatasetImportJobSummaryTypeDef:
return {
"datasetImportJobArn": ...,
}
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)
- See ImportModeType
DatasetSchemaSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetSchemaSummaryTypeDef
def get_value() -> DatasetSchemaSummaryTypeDef:
return {
"name": ...,
}
Definition
class DatasetSchemaSummaryTypeDef(TypedDict):
name: NotRequired[str],
schemaArn: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
domain: NotRequired[DomainType], # (1)
- See DomainType
DatasetSchemaTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetSchemaTypeDef
def get_value() -> DatasetSchemaTypeDef:
return {
"name": ...,
}
Definition
class DatasetSchemaTypeDef(TypedDict):
name: NotRequired[str],
schemaArn: NotRequired[str],
schema: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
domain: NotRequired[DomainType], # (1)
- See DomainType
DatasetSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetSummaryTypeDef
def get_value() -> DatasetSummaryTypeDef:
return {
"name": ...,
}
Definition
class DatasetSummaryTypeDef(TypedDict):
name: NotRequired[str],
datasetArn: NotRequired[str],
datasetType: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
DatasetTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetTypeDef
def get_value() -> DatasetTypeDef:
return {
"name": ...,
}
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],
DefaultCategoricalHyperParameterRangeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DefaultCategoricalHyperParameterRangeTypeDef
def get_value() -> DefaultCategoricalHyperParameterRangeTypeDef:
return {
"name": ...,
}
Definition
class DefaultCategoricalHyperParameterRangeTypeDef(TypedDict):
name: NotRequired[str],
values: NotRequired[List[str]],
isTunable: NotRequired[bool],
DefaultContinuousHyperParameterRangeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DefaultContinuousHyperParameterRangeTypeDef
def get_value() -> DefaultContinuousHyperParameterRangeTypeDef:
return {
"name": ...,
}
Definition
class DefaultContinuousHyperParameterRangeTypeDef(TypedDict):
name: NotRequired[str],
minValue: NotRequired[float],
maxValue: NotRequired[float],
isTunable: NotRequired[bool],
DefaultIntegerHyperParameterRangeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DefaultIntegerHyperParameterRangeTypeDef
def get_value() -> DefaultIntegerHyperParameterRangeTypeDef:
return {
"name": ...,
}
Definition
class DefaultIntegerHyperParameterRangeTypeDef(TypedDict):
name: NotRequired[str],
minValue: NotRequired[int],
maxValue: NotRequired[int],
isTunable: NotRequired[bool],
DeleteCampaignRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteCampaignRequestRequestTypeDef
def get_value() -> DeleteCampaignRequestRequestTypeDef:
return {
"campaignArn": ...,
}
DeleteDatasetGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteDatasetGroupRequestRequestTypeDef
def get_value() -> DeleteDatasetGroupRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
DeleteDatasetRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteDatasetRequestRequestTypeDef
def get_value() -> DeleteDatasetRequestRequestTypeDef:
return {
"datasetArn": ...,
}
DeleteEventTrackerRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteEventTrackerRequestRequestTypeDef
def get_value() -> DeleteEventTrackerRequestRequestTypeDef:
return {
"eventTrackerArn": ...,
}
DeleteFilterRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteFilterRequestRequestTypeDef
def get_value() -> DeleteFilterRequestRequestTypeDef:
return {
"filterArn": ...,
}
DeleteMetricAttributionRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteMetricAttributionRequestRequestTypeDef
def get_value() -> DeleteMetricAttributionRequestRequestTypeDef:
return {
"metricAttributionArn": ...,
}
DeleteRecommenderRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteRecommenderRequestRequestTypeDef
def get_value() -> DeleteRecommenderRequestRequestTypeDef:
return {
"recommenderArn": ...,
}
DeleteSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteSchemaRequestRequestTypeDef
def get_value() -> DeleteSchemaRequestRequestTypeDef:
return {
"schemaArn": ...,
}
DeleteSolutionRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DeleteSolutionRequestRequestTypeDef
def get_value() -> DeleteSolutionRequestRequestTypeDef:
return {
"solutionArn": ...,
}
DescribeAlgorithmRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeAlgorithmRequestRequestTypeDef
def get_value() -> DescribeAlgorithmRequestRequestTypeDef:
return {
"algorithmArn": ...,
}
DescribeBatchInferenceJobRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeBatchInferenceJobRequestRequestTypeDef
def get_value() -> DescribeBatchInferenceJobRequestRequestTypeDef:
return {
"batchInferenceJobArn": ...,
}
Definition
class DescribeBatchInferenceJobRequestRequestTypeDef(TypedDict):
batchInferenceJobArn: str,
DescribeBatchSegmentJobRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeBatchSegmentJobRequestRequestTypeDef
def get_value() -> DescribeBatchSegmentJobRequestRequestTypeDef:
return {
"batchSegmentJobArn": ...,
}
DescribeCampaignRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeCampaignRequestRequestTypeDef
def get_value() -> DescribeCampaignRequestRequestTypeDef:
return {
"campaignArn": ...,
}
DescribeDatasetExportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeDatasetExportJobRequestRequestTypeDef
def get_value() -> DescribeDatasetExportJobRequestRequestTypeDef:
return {
"datasetExportJobArn": ...,
}
DescribeDatasetGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeDatasetGroupRequestRequestTypeDef
def get_value() -> DescribeDatasetGroupRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
DescribeDatasetImportJobRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeDatasetImportJobRequestRequestTypeDef
def get_value() -> DescribeDatasetImportJobRequestRequestTypeDef:
return {
"datasetImportJobArn": ...,
}
DescribeDatasetRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeDatasetRequestRequestTypeDef
def get_value() -> DescribeDatasetRequestRequestTypeDef:
return {
"datasetArn": ...,
}
DescribeEventTrackerRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeEventTrackerRequestRequestTypeDef
def get_value() -> DescribeEventTrackerRequestRequestTypeDef:
return {
"eventTrackerArn": ...,
}
EventTrackerTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import EventTrackerTypeDef
def get_value() -> EventTrackerTypeDef:
return {
"name": ...,
}
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
Usage Example
from mypy_boto3_personalize.type_defs import DescribeFeatureTransformationRequestRequestTypeDef
def get_value() -> DescribeFeatureTransformationRequestRequestTypeDef:
return {
"featureTransformationArn": ...,
}
Definition
class DescribeFeatureTransformationRequestRequestTypeDef(TypedDict):
featureTransformationArn: str,
FeatureTransformationTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import FeatureTransformationTypeDef
def get_value() -> FeatureTransformationTypeDef:
return {
"name": ...,
}
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
Usage Example
from mypy_boto3_personalize.type_defs import DescribeFilterRequestRequestTypeDef
def get_value() -> DescribeFilterRequestRequestTypeDef:
return {
"filterArn": ...,
}
FilterTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import FilterTypeDef
def get_value() -> FilterTypeDef:
return {
"name": ...,
}
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
Usage Example
from mypy_boto3_personalize.type_defs import DescribeMetricAttributionRequestRequestTypeDef
def get_value() -> DescribeMetricAttributionRequestRequestTypeDef:
return {
"metricAttributionArn": ...,
}
Definition
class DescribeMetricAttributionRequestRequestTypeDef(TypedDict):
metricAttributionArn: str,
DescribeRecipeRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeRecipeRequestRequestTypeDef
def get_value() -> DescribeRecipeRequestRequestTypeDef:
return {
"recipeArn": ...,
}
RecipeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import RecipeTypeDef
def get_value() -> RecipeTypeDef:
return {
"name": ...,
}
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
Usage Example
from mypy_boto3_personalize.type_defs import DescribeRecommenderRequestRequestTypeDef
def get_value() -> DescribeRecommenderRequestRequestTypeDef:
return {
"recommenderArn": ...,
}
DescribeSchemaRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeSchemaRequestRequestTypeDef
def get_value() -> DescribeSchemaRequestRequestTypeDef:
return {
"schemaArn": ...,
}
DescribeSolutionRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeSolutionRequestRequestTypeDef
def get_value() -> DescribeSolutionRequestRequestTypeDef:
return {
"solutionArn": ...,
}
DescribeSolutionVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DescribeSolutionVersionRequestRequestTypeDef
def get_value() -> DescribeSolutionVersionRequestRequestTypeDef:
return {
"solutionVersionArn": ...,
}
EventTrackerSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import EventTrackerSummaryTypeDef
def get_value() -> EventTrackerSummaryTypeDef:
return {
"name": ...,
}
Definition
class EventTrackerSummaryTypeDef(TypedDict):
name: NotRequired[str],
eventTrackerArn: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
FilterSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import FilterSummaryTypeDef
def get_value() -> FilterSummaryTypeDef:
return {
"name": ...,
}
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
Usage Example
from mypy_boto3_personalize.type_defs import GetSolutionMetricsRequestRequestTypeDef
def get_value() -> GetSolutionMetricsRequestRequestTypeDef:
return {
"solutionVersionArn": ...,
}
HPOObjectiveTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import HPOObjectiveTypeDef
def get_value() -> HPOObjectiveTypeDef:
return {
"type": ...,
}
Definition
class HPOObjectiveTypeDef(TypedDict):
type: NotRequired[str],
metricName: NotRequired[str],
metricRegex: NotRequired[str],
HPOResourceConfigTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import HPOResourceConfigTypeDef
def get_value() -> HPOResourceConfigTypeDef:
return {
"maxNumberOfTrainingJobs": ...,
}
Definition
class HPOResourceConfigTypeDef(TypedDict):
maxNumberOfTrainingJobs: NotRequired[str],
maxParallelTrainingJobs: NotRequired[str],
IntegerHyperParameterRangeTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import IntegerHyperParameterRangeTypeDef
def get_value() -> IntegerHyperParameterRangeTypeDef:
return {
"name": ...,
}
Definition
class IntegerHyperParameterRangeTypeDef(TypedDict):
name: NotRequired[str],
minValue: NotRequired[int],
maxValue: NotRequired[int],
PaginatorConfigTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import PaginatorConfigTypeDef
def get_value() -> PaginatorConfigTypeDef:
return {
"MaxItems": ...,
}
Definition
class PaginatorConfigTypeDef(TypedDict):
MaxItems: NotRequired[int],
PageSize: NotRequired[int],
StartingToken: NotRequired[str],
ListBatchInferenceJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListBatchInferenceJobsRequestRequestTypeDef
def get_value() -> ListBatchInferenceJobsRequestRequestTypeDef:
return {
"solutionVersionArn": ...,
}
Definition
class ListBatchInferenceJobsRequestRequestTypeDef(TypedDict):
solutionVersionArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListBatchSegmentJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListBatchSegmentJobsRequestRequestTypeDef
def get_value() -> ListBatchSegmentJobsRequestRequestTypeDef:
return {
"solutionVersionArn": ...,
}
Definition
class ListBatchSegmentJobsRequestRequestTypeDef(TypedDict):
solutionVersionArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListCampaignsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListCampaignsRequestRequestTypeDef
def get_value() -> ListCampaignsRequestRequestTypeDef:
return {
"solutionArn": ...,
}
Definition
class ListCampaignsRequestRequestTypeDef(TypedDict):
solutionArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDatasetExportJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListDatasetExportJobsRequestRequestTypeDef
def get_value() -> ListDatasetExportJobsRequestRequestTypeDef:
return {
"datasetArn": ...,
}
Definition
class ListDatasetExportJobsRequestRequestTypeDef(TypedDict):
datasetArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDatasetGroupsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListDatasetGroupsRequestRequestTypeDef
def get_value() -> ListDatasetGroupsRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListDatasetGroupsRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDatasetImportJobsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListDatasetImportJobsRequestRequestTypeDef
def get_value() -> ListDatasetImportJobsRequestRequestTypeDef:
return {
"datasetArn": ...,
}
Definition
class ListDatasetImportJobsRequestRequestTypeDef(TypedDict):
datasetArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListDatasetsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListDatasetsRequestRequestTypeDef
def get_value() -> ListDatasetsRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
Definition
class ListDatasetsRequestRequestTypeDef(TypedDict):
datasetGroupArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListEventTrackersRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListEventTrackersRequestRequestTypeDef
def get_value() -> ListEventTrackersRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
Definition
class ListEventTrackersRequestRequestTypeDef(TypedDict):
datasetGroupArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListFiltersRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListFiltersRequestRequestTypeDef
def get_value() -> ListFiltersRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
Definition
class ListFiltersRequestRequestTypeDef(TypedDict):
datasetGroupArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListMetricAttributionMetricsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListMetricAttributionMetricsRequestRequestTypeDef
def get_value() -> ListMetricAttributionMetricsRequestRequestTypeDef:
return {
"metricAttributionArn": ...,
}
Definition
class ListMetricAttributionMetricsRequestRequestTypeDef(TypedDict):
metricAttributionArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListMetricAttributionsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListMetricAttributionsRequestRequestTypeDef
def get_value() -> ListMetricAttributionsRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
Definition
class ListMetricAttributionsRequestRequestTypeDef(TypedDict):
datasetGroupArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
MetricAttributionSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import MetricAttributionSummaryTypeDef
def get_value() -> MetricAttributionSummaryTypeDef:
return {
"name": ...,
}
Definition
class MetricAttributionSummaryTypeDef(TypedDict):
name: NotRequired[str],
metricAttributionArn: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
failureReason: NotRequired[str],
ListRecipesRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListRecipesRequestRequestTypeDef
def get_value() -> ListRecipesRequestRequestTypeDef:
return {
"recipeProvider": ...,
}
Definition
class ListRecipesRequestRequestTypeDef(TypedDict):
recipeProvider: NotRequired[RecipeProviderType], # (1)
nextToken: NotRequired[str],
maxResults: NotRequired[int],
domain: NotRequired[DomainType], # (2)
- See RecipeProviderType
- See DomainType
RecipeSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import RecipeSummaryTypeDef
def get_value() -> RecipeSummaryTypeDef:
return {
"name": ...,
}
Definition
class RecipeSummaryTypeDef(TypedDict):
name: NotRequired[str],
recipeArn: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
domain: NotRequired[DomainType], # (1)
- See DomainType
ListRecommendersRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListRecommendersRequestRequestTypeDef
def get_value() -> ListRecommendersRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
Definition
class ListRecommendersRequestRequestTypeDef(TypedDict):
datasetGroupArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListSchemasRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListSchemasRequestRequestTypeDef
def get_value() -> ListSchemasRequestRequestTypeDef:
return {
"nextToken": ...,
}
Definition
class ListSchemasRequestRequestTypeDef(TypedDict):
nextToken: NotRequired[str],
maxResults: NotRequired[int],
ListSolutionVersionsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListSolutionVersionsRequestRequestTypeDef
def get_value() -> ListSolutionVersionsRequestRequestTypeDef:
return {
"solutionArn": ...,
}
Definition
class ListSolutionVersionsRequestRequestTypeDef(TypedDict):
solutionArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
SolutionVersionSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import SolutionVersionSummaryTypeDef
def get_value() -> SolutionVersionSummaryTypeDef:
return {
"solutionVersionArn": ...,
}
Definition
class SolutionVersionSummaryTypeDef(TypedDict):
solutionVersionArn: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
failureReason: NotRequired[str],
ListSolutionsRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListSolutionsRequestRequestTypeDef
def get_value() -> ListSolutionsRequestRequestTypeDef:
return {
"datasetGroupArn": ...,
}
Definition
class ListSolutionsRequestRequestTypeDef(TypedDict):
datasetGroupArn: NotRequired[str],
nextToken: NotRequired[str],
maxResults: NotRequired[int],
SolutionSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import SolutionSummaryTypeDef
def get_value() -> SolutionSummaryTypeDef:
return {
"name": ...,
}
Definition
class SolutionSummaryTypeDef(TypedDict):
name: NotRequired[str],
solutionArn: NotRequired[str],
status: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
recipeArn: NotRequired[str],
ListTagsForResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import ListTagsForResourceRequestRequestTypeDef
def get_value() -> ListTagsForResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
}
OptimizationObjectiveTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import OptimizationObjectiveTypeDef
def get_value() -> OptimizationObjectiveTypeDef:
return {
"itemAttribute": ...,
}
Definition
class OptimizationObjectiveTypeDef(TypedDict):
itemAttribute: NotRequired[str],
objectiveSensitivity: NotRequired[ObjectiveSensitivityType], # (1)
TunedHPOParamsTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import TunedHPOParamsTypeDef
def get_value() -> TunedHPOParamsTypeDef:
return {
"algorithmHyperParameters": ...,
}
Definition
class TunedHPOParamsTypeDef(TypedDict):
algorithmHyperParameters: NotRequired[Dict[str, str]],
StartRecommenderRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import StartRecommenderRequestRequestTypeDef
def get_value() -> StartRecommenderRequestRequestTypeDef:
return {
"recommenderArn": ...,
}
StopRecommenderRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import StopRecommenderRequestRequestTypeDef
def get_value() -> StopRecommenderRequestRequestTypeDef:
return {
"recommenderArn": ...,
}
StopSolutionVersionCreationRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import StopSolutionVersionCreationRequestRequestTypeDef
def get_value() -> StopSolutionVersionCreationRequestRequestTypeDef:
return {
"solutionVersionArn": ...,
}
Definition
class StopSolutionVersionCreationRequestRequestTypeDef(TypedDict):
solutionVersionArn: str,
UntagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import UntagResourceRequestRequestTypeDef
def get_value() -> UntagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tagKeys": ...,
}
Definition
class UntagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tagKeys: Sequence[str],
BatchInferenceJobInputTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import BatchInferenceJobInputTypeDef
def get_value() -> BatchInferenceJobInputTypeDef:
return {
"s3DataSource": ...,
}
BatchInferenceJobOutputTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import BatchInferenceJobOutputTypeDef
def get_value() -> BatchInferenceJobOutputTypeDef:
return {
"s3DataDestination": ...,
}
Definition
class BatchInferenceJobOutputTypeDef(TypedDict):
s3DataDestination: S3DataConfigTypeDef, # (1)
BatchSegmentJobInputTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import BatchSegmentJobInputTypeDef
def get_value() -> BatchSegmentJobInputTypeDef:
return {
"s3DataSource": ...,
}
BatchSegmentJobOutputTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import BatchSegmentJobOutputTypeDef
def get_value() -> BatchSegmentJobOutputTypeDef:
return {
"s3DataDestination": ...,
}
Definition
class BatchSegmentJobOutputTypeDef(TypedDict):
s3DataDestination: S3DataConfigTypeDef, # (1)
DatasetExportJobOutputTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import DatasetExportJobOutputTypeDef
def get_value() -> DatasetExportJobOutputTypeDef:
return {
"s3DataDestination": ...,
}
Definition
class DatasetExportJobOutputTypeDef(TypedDict):
s3DataDestination: S3DataConfigTypeDef, # (1)
MetricAttributionOutputTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import MetricAttributionOutputTypeDef
def get_value() -> MetricAttributionOutputTypeDef:
return {
"roleArn": ...,
}
Definition
class MetricAttributionOutputTypeDef(TypedDict):
roleArn: str,
s3DataDestination: NotRequired[S3DataConfigTypeDef], # (1)
CampaignUpdateSummaryTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CampaignUpdateSummaryTypeDef
def get_value() -> CampaignUpdateSummaryTypeDef:
return {
"solutionVersionArn": ...,
}
Definition
class CampaignUpdateSummaryTypeDef(TypedDict):
solutionVersionArn: NotRequired[str],
minProvisionedTPS: NotRequired[int],
campaignConfig: NotRequired[CampaignConfigTypeDef], # (1)
status: NotRequired[str],
failureReason: NotRequired[str],
creationDateTime: NotRequired[datetime],
lastUpdatedDateTime: NotRequired[datetime],
UpdateCampaignRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import UpdateCampaignRequestRequestTypeDef
def get_value() -> UpdateCampaignRequestRequestTypeDef:
return {
"campaignArn": ...,
}
Definition
class UpdateCampaignRequestRequestTypeDef(TypedDict):
campaignArn: str,
solutionVersionArn: NotRequired[str],
minProvisionedTPS: NotRequired[int],
campaignConfig: NotRequired[CampaignConfigTypeDef], # (1)
CreateCampaignRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateCampaignRequestRequestTypeDef
def get_value() -> CreateCampaignRequestRequestTypeDef:
return {
"name": ...,
"solutionVersionArn": ...,
}
Definition
class CreateCampaignRequestRequestTypeDef(TypedDict):
name: str,
solutionVersionArn: str,
minProvisionedTPS: NotRequired[int],
campaignConfig: NotRequired[CampaignConfigTypeDef], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See CampaignConfigTypeDef
- See TagTypeDef
CreateDatasetGroupRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateDatasetGroupRequestRequestTypeDef
def get_value() -> CreateDatasetGroupRequestRequestTypeDef:
return {
"name": ...,
}
Definition
class CreateDatasetGroupRequestRequestTypeDef(TypedDict):
name: str,
roleArn: NotRequired[str],
kmsKeyArn: NotRequired[str],
domain: NotRequired[DomainType], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See DomainType
- See TagTypeDef
CreateDatasetRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateDatasetRequestRequestTypeDef
def get_value() -> CreateDatasetRequestRequestTypeDef:
return {
"name": ...,
"schemaArn": ...,
"datasetGroupArn": ...,
"datasetType": ...,
}
Definition
class CreateDatasetRequestRequestTypeDef(TypedDict):
name: str,
schemaArn: str,
datasetGroupArn: str,
datasetType: str,
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateEventTrackerRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateEventTrackerRequestRequestTypeDef
def get_value() -> CreateEventTrackerRequestRequestTypeDef:
return {
"name": ...,
"datasetGroupArn": ...,
}
Definition
class CreateEventTrackerRequestRequestTypeDef(TypedDict):
name: str,
datasetGroupArn: str,
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateFilterRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateFilterRequestRequestTypeDef
def get_value() -> CreateFilterRequestRequestTypeDef:
return {
"name": ...,
"datasetGroupArn": ...,
"filterExpression": ...,
}
Definition
class CreateFilterRequestRequestTypeDef(TypedDict):
name: str,
datasetGroupArn: str,
filterExpression: str,
tags: NotRequired[Sequence[TagTypeDef]], # (1)
- See TagTypeDef
CreateSolutionVersionRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateSolutionVersionRequestRequestTypeDef
def get_value() -> CreateSolutionVersionRequestRequestTypeDef:
return {
"solutionArn": ...,
}
Definition
class CreateSolutionVersionRequestRequestTypeDef(TypedDict):
solutionArn: str,
name: NotRequired[str],
trainingMode: NotRequired[TrainingModeType], # (1)
tags: NotRequired[Sequence[TagTypeDef]], # (2)
- See TrainingModeType
- See TagTypeDef
TagResourceRequestRequestTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import TagResourceRequestRequestTypeDef
def get_value() -> TagResourceRequestRequestTypeDef:
return {
"resourceArn": ...,
"tags": ...,
}
Definition
class TagResourceRequestRequestTypeDef(TypedDict):
resourceArn: str,
tags: Sequence[TagTypeDef], # (1)
- See TagTypeDef
CreateBatchInferenceJobResponseTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateBatchInferenceJobResponseTypeDef
def get_value() -> CreateBatchInferenceJobResponseTypeDef:
return {
"batchInferenceJobArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateBatchInferenceJobResponseTypeDef(TypedDict):
batchInferenceJobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)
CreateBatchSegmentJobResponseTypeDef
Usage Example
from mypy_boto3_personalize.type_defs import CreateBatchSegmentJobResponseTypeDef
def get_value() -> CreateBatchSegmentJobResponseTypeDef:
return {
"batchSegmentJobArn": ...,
"ResponseMetadata": ...,
}
Definition
class CreateBatchSegmentJobResponseTypeDef(TypedDict):
batchSegmentJobArn: str,
ResponseMetadata: ResponseMetadataTypeDef, # (1)