Typed dictionaries#

Index > PersonalizeRuntime > Typed dictionaries

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

GetPersonalizedRankingRequestRequestTypeDef#

# GetPersonalizedRankingRequestRequestTypeDef usage example

from mypy_boto3_personalize_runtime.type_defs import GetPersonalizedRankingRequestRequestTypeDef

def get_value() -> GetPersonalizedRankingRequestRequestTypeDef:
    return {
        "campaignArn": ...,
        "inputList": ...,
        "userId": ...,
    }

# GetPersonalizedRankingRequestRequestTypeDef definition

class GetPersonalizedRankingRequestRequestTypeDef(TypedDict):
    campaignArn: str,
    inputList: Sequence[str],
    userId: str,
    context: NotRequired[Mapping[str, str]],
    filterArn: NotRequired[str],
    filterValues: NotRequired[Mapping[str, str]],

PredictedItemTypeDef#

# PredictedItemTypeDef 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],

PromotionTypeDef#

# PromotionTypeDef 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]],

ResponseMetadataTypeDef#

# ResponseMetadataTypeDef usage example

from mypy_boto3_personalize_runtime.type_defs import ResponseMetadataTypeDef

def get_value() -> ResponseMetadataTypeDef:
    return {
        "RequestId": ...,
        "HostId": ...,
        "HTTPStatusCode": ...,
        "HTTPHeaders": ...,
        "RetryAttempts": ...,
    }

# ResponseMetadataTypeDef definition

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

GetPersonalizedRankingResponseTypeDef#

# GetPersonalizedRankingResponseTypeDef usage example

from mypy_boto3_personalize_runtime.type_defs import GetPersonalizedRankingResponseTypeDef

def get_value() -> GetPersonalizedRankingResponseTypeDef:
    return {
        "personalizedRanking": ...,
        "recommendationId": ...,
        "ResponseMetadata": ...,
    }

# GetPersonalizedRankingResponseTypeDef definition

class GetPersonalizedRankingResponseTypeDef(TypedDict):
    personalizedRanking: List[PredictedItemTypeDef],  # (1)
    recommendationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See PredictedItemTypeDef
See ResponseMetadataTypeDef

GetRecommendationsResponseTypeDef#

# GetRecommendationsResponseTypeDef usage example

from mypy_boto3_personalize_runtime.type_defs import GetRecommendationsResponseTypeDef

def get_value() -> GetRecommendationsResponseTypeDef:
    return {
        "itemList": ...,
        "recommendationId": ...,
        "ResponseMetadata": ...,
    }

# GetRecommendationsResponseTypeDef definition

class GetRecommendationsResponseTypeDef(TypedDict):
    itemList: List[PredictedItemTypeDef],  # (1)
    recommendationId: str,
    ResponseMetadata: ResponseMetadataTypeDef,  # (2)

See PredictedItemTypeDef
See ResponseMetadataTypeDef

GetRecommendationsRequestRequestTypeDef#

# GetRecommendationsRequestRequestTypeDef usage example

from mypy_boto3_personalize_runtime.type_defs import GetRecommendationsRequestRequestTypeDef

def get_value() -> GetRecommendationsRequestRequestTypeDef:
    return {
        "campaignArn": ...,
    }

# GetRecommendationsRequestRequestTypeDef definition

class GetRecommendationsRequestRequestTypeDef(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)

See PromotionTypeDef