Type definitions#
Index > PersonalizeRuntime > Type definitions
Auto-generated documentation for PersonalizeRuntime type annotations stubs module mypy-boto3-personalize-runtime.
GetActionRecommendationsRequestTypeDef#
# GetActionRecommendationsRequestTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import GetActionRecommendationsRequestTypeDef
def get_value() -> GetActionRecommendationsRequestTypeDef:
return {
"campaignArn": ...,
}
# GetActionRecommendationsRequestTypeDef definition
class GetActionRecommendationsRequestTypeDef(TypedDict):
campaignArn: NotRequired[str],
userId: NotRequired[str],
numResults: NotRequired[int],
filterArn: NotRequired[str],
filterValues: NotRequired[Mapping[str, str]],
PredictedActionTypeDef#
# PredictedActionTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import PredictedActionTypeDef
def get_value() -> PredictedActionTypeDef:
return {
"actionId": ...,
}
# PredictedActionTypeDef definition
class PredictedActionTypeDef(TypedDict):
actionId: NotRequired[str],
score: NotRequired[float],
ResponseMetadataTypeDef#
# ResponseMetadataTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import ResponseMetadataTypeDef
def get_value() -> ResponseMetadataTypeDef:
return {
"RequestId": ...,
}
# ResponseMetadataTypeDef definition
class ResponseMetadataTypeDef(TypedDict):
RequestId: str,
HTTPStatusCode: int,
HTTPHeaders: Dict[str, str],
RetryAttempts: int,
HostId: NotRequired[str],
GetPersonalizedRankingRequestTypeDef#
# GetPersonalizedRankingRequestTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import GetPersonalizedRankingRequestTypeDef
def get_value() -> GetPersonalizedRankingRequestTypeDef:
return {
"campaignArn": ...,
}
# GetPersonalizedRankingRequestTypeDef definition
class GetPersonalizedRankingRequestTypeDef(TypedDict):
campaignArn: str,
inputList: Sequence[str],
userId: str,
context: NotRequired[Mapping[str, str]],
filterArn: NotRequired[str],
filterValues: NotRequired[Mapping[str, str]],
metadataColumns: NotRequired[Mapping[str, Sequence[str]]],
PredictedItemTypeDef#
# PredictedItemTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import PredictedItemTypeDef
def get_value() -> PredictedItemTypeDef:
return {
"itemId": ...,
}
# PredictedItemTypeDef definition
class PredictedItemTypeDef(TypedDict):
itemId: NotRequired[str],
score: NotRequired[float],
promotionName: NotRequired[str],
metadata: NotRequired[Dict[str, str]],
reason: NotRequired[List[str]],
PromotionTypeDef#
# PromotionTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import PromotionTypeDef
def get_value() -> PromotionTypeDef:
return {
"name": ...,
}
# PromotionTypeDef definition
class PromotionTypeDef(TypedDict):
name: NotRequired[str],
percentPromotedItems: NotRequired[int],
filterArn: NotRequired[str],
filterValues: NotRequired[Mapping[str, str]],
GetActionRecommendationsResponseTypeDef#
# GetActionRecommendationsResponseTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import GetActionRecommendationsResponseTypeDef
def get_value() -> GetActionRecommendationsResponseTypeDef:
return {
"actionList": ...,
}
# GetActionRecommendationsResponseTypeDef definition
class GetActionRecommendationsResponseTypeDef(TypedDict):
actionList: List[PredictedActionTypeDef], # (1)
recommendationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See
List[PredictedActionTypeDef]
- See ResponseMetadataTypeDef
GetPersonalizedRankingResponseTypeDef#
# GetPersonalizedRankingResponseTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import GetPersonalizedRankingResponseTypeDef
def get_value() -> GetPersonalizedRankingResponseTypeDef:
return {
"personalizedRanking": ...,
}
# GetPersonalizedRankingResponseTypeDef definition
class GetPersonalizedRankingResponseTypeDef(TypedDict):
personalizedRanking: List[PredictedItemTypeDef], # (1)
recommendationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See
List[PredictedItemTypeDef]
- See ResponseMetadataTypeDef
GetRecommendationsResponseTypeDef#
# GetRecommendationsResponseTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import GetRecommendationsResponseTypeDef
def get_value() -> GetRecommendationsResponseTypeDef:
return {
"itemList": ...,
}
# GetRecommendationsResponseTypeDef definition
class GetRecommendationsResponseTypeDef(TypedDict):
itemList: List[PredictedItemTypeDef], # (1)
recommendationId: str,
ResponseMetadata: ResponseMetadataTypeDef, # (2)
- See
List[PredictedItemTypeDef]
- See ResponseMetadataTypeDef
GetRecommendationsRequestTypeDef#
# GetRecommendationsRequestTypeDef TypedDict usage example
from mypy_boto3_personalize_runtime.type_defs import GetRecommendationsRequestTypeDef
def get_value() -> GetRecommendationsRequestTypeDef:
return {
"campaignArn": ...,
}
# GetRecommendationsRequestTypeDef definition
class GetRecommendationsRequestTypeDef(TypedDict):
campaignArn: NotRequired[str],
itemId: NotRequired[str],
userId: NotRequired[str],
numResults: NotRequired[int],
context: NotRequired[Mapping[str, str]],
filterArn: NotRequired[str],
filterValues: NotRequired[Mapping[str, str]],
recommenderArn: NotRequired[str],
promotions: NotRequired[Sequence[PromotionTypeDef]], # (1)
metadataColumns: NotRequired[Mapping[str, Sequence[str]]],
- See
Sequence[PromotionTypeDef]