get_user async ¶

async def get_user(
    self,
    network_id: "capo_wickr.types.network_id.NetworkId",
    user_id: "capo_wickr.types.user_id.UserId",
    *,
    config_overrides: Optional[AsyncWickrClientConfig] = None,
    start_time: Optional[datetime.datetime] = None,
    end_time: Optional[datetime.datetime] = None,
) -> "capo_wickr.types.get_user_response.GetUserResponse":
    """<p>Retrieves detailed information about a specific user in a Wickr network, including their profile, status, and activity history.</p>

    Args:
        network_id: <p>The ID of the Wickr network containing the user.</p>
        user_id: <p>The unique identifier of the user to retrieve.</p>
        start_time: <p>The start time for filtering the user's last activity. Only activity after this timestamp will be considered. Time is specified in epoch seconds.</p>
        end_time: <p>The end time for filtering the user's last activity. Only activity before this timestamp will be considered. Time is specified in epoch seconds.</p>

    Raises:
        capo_wickr.errors.bad_request_error.BadRequestError: <p>The request was invalid or malformed. This error occurs when the request parameters do not meet the API requirements, such as invalid field values, missing required parameters, or improperly formatted data.</p>
        capo_wickr.errors.forbidden_error.ForbiddenError: <p>Access to the requested resource is forbidden. This error occurs when the authenticated user does not have the necessary permissions to perform the requested operation, even though they are authenticated.</p>
        capo_wickr.errors.internal_server_error.InternalServerError: <p>An unexpected error occurred on the server while processing the request. This indicates a problem with the Wickr service itself rather than with the request. If this error persists, contact Amazon Web Services Support.</p>
        capo_wickr.errors.rate_limit_error.RateLimitError: <p>The request was throttled because too many requests were sent in a short period of time. Wait a moment and retry the request. Consider implementing exponential backoff in your application.</p>
        capo_wickr.errors.resource_not_found_error.ResourceNotFoundError: <p>The requested resource could not be found. This error occurs when you try to access or modify a network, user, bot, security group, or other resource that doesn't exist or has been deleted.</p>
        capo_wickr.errors.unauthorized_error.UnauthorizedError: <p>The request was not authenticated or the authentication credentials were invalid. This error occurs when the request lacks valid authentication credentials or the credentials have expired.</p>
        capo_wickr.errors.validation_error.ValidationError: <p>One or more fields in the request failed validation. This error provides detailed information about which fields were invalid and why, allowing you to correct the request and retry.</p>
        capo_wickr.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        Get user information

        >>> await client.get_user(network_id='12345678', user_id='12345')
        Get user info with activity time range

        >>> await client.get_user(network_id='12345678', user_id='12345', start_time=1704067200, end_time=1705500000)
        User not found error

        >>> await client.get_user(network_id='12345678', user_id='99999')
        Invalid userId error

        >>> await client.get_user(network_id='12345678', user_id='99999')
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_wickr.types.get_user_request.GetUserRequest]",
    ) -> AsyncOperationResponse[
        "capo_wickr.types.get_user_response.GetUserResponse"
    ]:
        import capo_wickr._operations.wickr_admin_api.get_user

        (
            output,
            http_response,
        ) = await capo_wickr._operations.wickr_admin_api.get_user.async_get_user(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    def _redact_output(
        output: "capo_wickr.types.get_user_response.GetUserResponse",
    ) -> dict[str, Any]:
        import capo_wickr.types.get_user_response

        return capo_wickr.types.get_user_response.redact_sensitive(output)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetUser", redact_output=_redact_output)
    )
    input_: capo_wickr.types.get_user_request.GetUserRequest = {
        "network_id": network_id,
        "user_id": user_id,
    }
    if start_time is not None:
        input_["start_time"] = start_time
    if end_time is not None:
        input_["end_time"] = end_time

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