Typed dictionaries

Index > PersonalizeEvents > Typed dictionaries

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

EmptyResponseMetadataTypeDef

# EmptyResponseMetadataTypeDef usage example

from mypy_boto3_personalize_events.type_defs import EmptyResponseMetadataTypeDef

def get_value() -> EmptyResponseMetadataTypeDef:
    return {
        "ResponseMetadata": ...,
    }

# EmptyResponseMetadataTypeDef definition

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

1. See ResponseMetadataTypeDef

MetricAttributionTypeDef

# MetricAttributionTypeDef usage example

from mypy_boto3_personalize_events.type_defs import MetricAttributionTypeDef

def get_value() -> MetricAttributionTypeDef:
    return {
        "eventAttributionSource": ...,
    }

# MetricAttributionTypeDef definition

class MetricAttributionTypeDef(TypedDict):
    eventAttributionSource: str,

ItemTypeDef

# ItemTypeDef usage example

from mypy_boto3_personalize_events.type_defs import ItemTypeDef

def get_value() -> ItemTypeDef:
    return {
        "itemId": ...,
    }

# ItemTypeDef definition

class ItemTypeDef(TypedDict):
    itemId: str,
    properties: NotRequired[str],

UserTypeDef

# UserTypeDef usage example

from mypy_boto3_personalize_events.type_defs import UserTypeDef

def get_value() -> UserTypeDef:
    return {
        "userId": ...,
    }

# UserTypeDef definition

class UserTypeDef(TypedDict):
    userId: str,
    properties: NotRequired[str],

ResponseMetadataTypeDef

# ResponseMetadataTypeDef usage example

from mypy_boto3_personalize_events.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,

EventTypeDef

# EventTypeDef usage example

from mypy_boto3_personalize_events.type_defs import EventTypeDef

def get_value() -> EventTypeDef:
    return {
        "eventType": ...,
        "sentAt": ...,
    }

# EventTypeDef definition

class EventTypeDef(TypedDict):
    eventType: str,
    sentAt: Union[datetime, str],
    eventId: NotRequired[str],
    eventValue: NotRequired[float],
    itemId: NotRequired[str],
    properties: NotRequired[str],
    recommendationId: NotRequired[str],
    impression: NotRequired[Sequence[str]],
    metricAttribution: NotRequired[MetricAttributionTypeDef],  # (1)

1. See MetricAttributionTypeDef

PutItemsRequestRequestTypeDef

# PutItemsRequestRequestTypeDef usage example

from mypy_boto3_personalize_events.type_defs import PutItemsRequestRequestTypeDef

def get_value() -> PutItemsRequestRequestTypeDef:
    return {
        "datasetArn": ...,
        "items": ...,
    }

# PutItemsRequestRequestTypeDef definition

class PutItemsRequestRequestTypeDef(TypedDict):
    datasetArn: str,
    items: Sequence[ItemTypeDef],  # (1)

1. See ItemTypeDef

PutUsersRequestRequestTypeDef

# PutUsersRequestRequestTypeDef usage example

from mypy_boto3_personalize_events.type_defs import PutUsersRequestRequestTypeDef

def get_value() -> PutUsersRequestRequestTypeDef:
    return {
        "datasetArn": ...,
        "users": ...,
    }

# PutUsersRequestRequestTypeDef definition

class PutUsersRequestRequestTypeDef(TypedDict):
    datasetArn: str,
    users: Sequence[UserTypeDef],  # (1)

1. See UserTypeDef

PutEventsRequestRequestTypeDef

# PutEventsRequestRequestTypeDef usage example

from mypy_boto3_personalize_events.type_defs import PutEventsRequestRequestTypeDef

def get_value() -> PutEventsRequestRequestTypeDef:
    return {
        "trackingId": ...,
        "sessionId": ...,
        "eventList": ...,
    }

# PutEventsRequestRequestTypeDef definition

class PutEventsRequestRequestTypeDef(TypedDict):
    trackingId: str,
    sessionId: str,
    eventList: Sequence[EventTypeDef],  # (1)
    userId: NotRequired[str],

1. See EventTypeDef