Skip to content

put_users async

put_users(
    dataset_arn: Arn,
    users: UserList,
    *,
    config_overrides: Optional[AsyncPersonalizeEventsClientConfig] = None,
) -> None

Adds one or more users to a Users dataset. For more information see Importing users individually.

Parameters:

  • dataset_arn (Arn) –

    The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.

  • users (UserList) –

    A list of user data.

Raises:

Source code in docs_src/capo_personalize_events/_services/async_personalize_events.py
async def put_users(
    self,
    dataset_arn: "capo_personalize_events.types.arn.Arn",
    users: "capo_personalize_events.types.user_list.UserList",
    *,
    config_overrides: Optional[AsyncPersonalizeEventsClientConfig] = None,
) -> None:
    """<p>Adds one or more users to a Users dataset. For more information see <a href="https://docs.aws.amazon.com/personalize/latest/dg/importing-users.html">Importing users individually</a>.</p>

    Args:
        dataset_arn: <p>The Amazon Resource Name (ARN) of the Users dataset you are adding the user or users to.</p>
        users: <p>A list of user data.</p>

    Raises:
        capo_personalize_events.errors.invalid_input_exception.InvalidInputException: <p>Provide a valid value for the field or parameter.</p>
        capo_personalize_events.errors.resource_in_use_exception.ResourceInUseException: <p>The specified resource is in use.</p>
        capo_personalize_events.errors.resource_not_found_exception.ResourceNotFoundException: <p>Could not find the specified resource.</p>
        capo_personalize_events.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_personalize_events.types.put_users_request.PutUsersRequest]",
    ) -> AsyncOperationResponse[None]:
        import capo_personalize_events._operations.amazon_personalize_events.put_users

        (
            output,
            http_response,
        ) = await capo_personalize_events._operations.amazon_personalize_events.put_users.async_put_users(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_personalize_events.types.put_users_request.PutUsersRequest",
    ) -> dict[str, Any]:
        import capo_personalize_events.types.put_users_request

        return capo_personalize_events.types.put_users_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("PutUsers", redact_input=_redact_input)
    )
    input_: capo_personalize_events.types.put_users_request.PutUsersRequest = {
        "dataset_arn": dataset_arn,
        "users": users,
    }

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output