PersonalizeEventsClient

Index > PersonalizeEvents > PersonalizeEventsClient

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

PersonalizeEventsClient

Type annotations and code completion for boto3.client("personalize-events"). boto3 documentation

# PersonalizeEventsClient usage example

from boto3.session import Session
from mypy_boto3_personalize_events.client import PersonalizeEventsClient

def get_personalize-events_client() -> PersonalizeEventsClient:
    return Session().client("personalize-events")

Exceptions

boto3 client exceptions are generated in runtime. This class provides code completion for boto3.client("personalize-events").exceptions structure.

# Exceptions.exceptions usage example

client = boto3.client("personalize-events")

try:
    do_something(client)
except (
    client.exceptions.ClientError,
    client.exceptions.InvalidInputException,
    client.exceptions.ResourceInUseException,
    client.exceptions.ResourceNotFoundException,
) as e:
    print(e)

# Exceptions.exceptions type checking example

from mypy_boto3_personalize_events.client import Exceptions

def handle_error(exc: Exceptions.ClientError) -> None:
    ...

Methods

can_paginate

Check if an operation can be paginated.

Type annotations and code completion for boto3.client("personalize-events").can_paginate method. boto3 documentation

# can_paginate method definition

def can_paginate(
    self,
    operation_name: str,
) -> bool:
    ...

close

Closes underlying endpoint connections.

Type annotations and code completion for boto3.client("personalize-events").close method. boto3 documentation

# close method definition

def close(
    self,
) -> None:
    ...

generate_presigned_url

Generate a presigned url given a client, its method, and arguments.

Type annotations and code completion for boto3.client("personalize-events").generate_presigned_url method. boto3 documentation

# generate_presigned_url method definition

def generate_presigned_url(
    self,
    ClientMethod: str,
    Params: Mapping[str, Any] = ...,
    ExpiresIn: int = 3600,
    HttpMethod: str = ...,
) -> str:
    ...

put_action_interactions

Records action interaction event data.

Type annotations and code completion for boto3.client("personalize-events").put_action_interactions method. boto3 documentation

# put_action_interactions method definition

def put_action_interactions(
    self,
    *,
    trackingId: str,
    actionInteractions: Sequence[ActionInteractionTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ActionInteractionTypeDef
2. See EmptyResponseMetadataTypeDef

# put_action_interactions method usage example with argument unpacking

kwargs: PutActionInteractionsRequestRequestTypeDef = {  # (1)
    "trackingId": ...,
    "actionInteractions": ...,
}

parent.put_action_interactions(**kwargs)

1. See PutActionInteractionsRequestRequestTypeDef

put_actions

Adds one or more actions to an Actions dataset.

Type annotations and code completion for boto3.client("personalize-events").put_actions method. boto3 documentation

# put_actions method definition

def put_actions(
    self,
    *,
    datasetArn: str,
    actions: Sequence[ActionTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ActionTypeDef
2. See EmptyResponseMetadataTypeDef

# put_actions method usage example with argument unpacking

kwargs: PutActionsRequestRequestTypeDef = {  # (1)
    "datasetArn": ...,
    "actions": ...,
}

parent.put_actions(**kwargs)

1. See PutActionsRequestRequestTypeDef

put_events

Records item interaction event data.

Type annotations and code completion for boto3.client("personalize-events").put_events method. boto3 documentation

# put_events method definition

def put_events(
    self,
    *,
    trackingId: str,
    sessionId: str,
    eventList: Sequence[EventTypeDef],  # (1)
    userId: str = ...,
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See EventTypeDef
2. See EmptyResponseMetadataTypeDef

# put_events method usage example with argument unpacking

kwargs: PutEventsRequestRequestTypeDef = {  # (1)
    "trackingId": ...,
    "sessionId": ...,
    "eventList": ...,
}

parent.put_events(**kwargs)

1. See PutEventsRequestRequestTypeDef

put_items

Adds one or more items to an Items dataset.

Type annotations and code completion for boto3.client("personalize-events").put_items method. boto3 documentation

# put_items method definition

def put_items(
    self,
    *,
    datasetArn: str,
    items: Sequence[ItemTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See ItemTypeDef
2. See EmptyResponseMetadataTypeDef

# put_items method usage example with argument unpacking

kwargs: PutItemsRequestRequestTypeDef = {  # (1)
    "datasetArn": ...,
    "items": ...,
}

parent.put_items(**kwargs)

1. See PutItemsRequestRequestTypeDef

put_users

Adds one or more users to a Users dataset.

Type annotations and code completion for boto3.client("personalize-events").put_users method. boto3 documentation

# put_users method definition

def put_users(
    self,
    *,
    datasetArn: str,
    users: Sequence[UserTypeDef],  # (1)
) -> EmptyResponseMetadataTypeDef:  # (2)
    ...

1. See UserTypeDef
2. See EmptyResponseMetadataTypeDef

# put_users method usage example with argument unpacking

kwargs: PutUsersRequestRequestTypeDef = {  # (1)
    "datasetArn": ...,
    "users": ...,
}

parent.put_users(**kwargs)

1. See PutUsersRequestRequestTypeDef